georgringer / doc
在后端直接基于Markdown文件渲染文档
1.1.1
2022-03-24 12:26 UTC
Requires
- typo3/cms-core: ^9 || ^10 || ^11
Replaces
- typo3-ter/doc: 1.1.1
This package is auto-updated.
Last update: 2024-09-06 07:53:55 UTC
README
此扩展向“帮助”菜单添加了一个名为“项目文档”的选项,让您可以在TYPO3 CMS后端内提供项目文档。
扩展还包含一个TYPO3 Dashboard扩展的小部件,以便您快速访问项目文档。
文档基于Markdown。这使得在构建自定义扩展或之后编写文档变得容易。您可以包括内容元素的描述、发布说明、提出问题的说明或其他需要记录的内容。
JavaScript库docsify将Markdown文件转换为美丽的HTML内容。
设置扩展
下载扩展。使用以下选项之一
- Composer:
composer req georgringer/doc
- TER: 从TER下载扩展
- TYPO3 后端: 在“扩展管理器”中下载扩展
配置
切换到 安装工具/设置 并自定义全局配置。如下面的截图所示,以下配置选项可用
文档根路径
:定义Markdown文件的路径文档名称
:文档名称,如侧边栏中显示暗黑模式
:启用暗黑模式
编写文档
没有文档,此扩展毫无用处 :)
查看此扩展中包含的示例文档,您可以将其用作指南 EXT:doc/Resources/Private/ExampleDocs
。另请参阅Markdown速查表,因为有一些很酷的功能可用。
创建自己的文档时,请确保将Markdown文件所在的文件夹放在Resources/Private
中。否则,Markdown文件可能对公众公开。