silverstripe/docsviewer

此包已弃用，不再维护。未建议替代包。

SilverStripe 文档查看器模块

维护者

详细信息

github.com/silverstripe/silverstripe-docsviewer

源代码

问题

IRC

安装: 14,239

依赖者: 3

建议者: 0

安全: 0

星标: 20

关注者: 17

分支: 25

开放问题: 7

类型:silverstripe-module

2.0.0 2019-02-14 07:56 UTC

Requires

Suggests

BSD-3-Clause 171652b33821d342ac1603c3bb0e0bdddc111a26

documentationsilverstripe

This package is auto-updated.

Last update: 2023-03-16 21:29:24 UTC

README

已弃用

此包已弃用。请参阅 silverstripe/doc.silverstripe.org。

Build Status

维护者联系方式

需求

这些通过 Composer 拉入。

  • SilverStripe 3.1
  • Parsedown 和 Parsedown Extra。

摘要

从给定的文件夹列表中读取 markdown 文件，并提供一个用于查看文档的 Web 界面。非常适合在模块或项目代码旁边提供文档。

此模块的一个变体为 SilverStripe 开发者文档和用户帮助网站提供动力。

有关如何使用该模块的更多文档，请阅读 /docs/Writing-Documentation.md（或通过网页浏览器在 /dev/docs/docsviewer/Writing-Documentation 中查看）

安装

composer require "silverstripe/docsviewer" "dev-master"

使用方法

通过 composer 安装文件后，重新构建 SilverStripe 数据库...

sake dev/build

然后从 yoursite.com/dev/docs 开始查看文档。

如果出现问题，您可以在 yoursite.com/dev/tasks/CheckDocsSourcesTask 运行 dev 任务来自动检查配置或源文件错误。

默认情况下，模块将显示已捆绑到任何已安装模块中的文档文件。要配置文档查看器中显示的内容，请参阅详细的 文档。

有关如何使用模块的更多信息，请参阅每个文档

* [Configuration](docs/en/configuration.md)
* [Markdown Syntax](docs/en/markdown.md)
* [Syntax Highlighting](docs/en/syntax-highlighting.md)
* [Publishing Static Files](docs/en/statichtml.md)

许可证

见 LICENSE