techdivision/docviewer

此Neos包允许您阅读已安装包的文档

安装数 11,145

依赖者: 0

建议者: 0

安全性: 0

星标: 2

关注者: 17

分支: 5

开放问题: 1

类型:neos-package

5.03 2021-02-23 20:32 UTC

README

此Neos包提供了一个后端模块,用于将所有已安装包的“文档”文件夹中的Markdown进行渲染。其想法是Neos.Editors能够阅读关于项目的特定手册。

例如,在您的Neos网站上可能有一些复杂的Neos.Editors编辑或配置功能。使用此模块,您可以为他们提供您的项目手册。

为什么不使用reStructuredText?

目前还没有稳定的PHP解决方案来渲染RST,特别是Neos文档。为了避免复杂的依赖,本项目仅支持Markdown。

特性

  • 列出带有文档的已安装包
  • 渲染带常见功能的Markdown
  • 可配置的黑名单以隐藏包
  • 可配置默认包

TechDivision Logo

待定

  • 可配置文档目录内的可选子目录,以便渲染,以实现开发者文档和用户手册的可能性