silverstripe/docstation

一个用于在CMS中查看用户文档的模块

安装: 767

依赖项: 0

建议者: 0

安全性: 0

星标: 5

关注者: 2

分支: 3

开放问题: 1

类型:silverstripe-vendormodule

dev-main 2021-11-23 10:53 UTC

This package is auto-updated.

Last update: 2024-08-23 17:00:32 UTC


README

提供与项目一起定位的Markdown文档的CMS UI浏览。

安装

composer require silverstripe/docstation

要求

  • silverstripe/graphql:4.x-dev
  • PHP >= 7.4

示例

app/
  docs/
    Adding-a-Product.md
    Cancelling-an-Order.md

app/docs/Adding-a-Product.md

---
title: How do add a product
sort: 1
---

## Been wondering how to add a product?

This guide will give you a
* Step
* by
* step

Tutorial!

自定义文档目录

默认为app/docs

SilverStripe\Docstation\Docstation:
  docs_dir: 'app/mydocs'

它还支持模块解析语法。

SilverStripe\Docstation\Docstation:
  docs_dir: 'somevendor/somemodule: docs'

待办事项

  • 嵌套文档,层次结构导航(不确定这是否是一个好主意)
  • 使其看起来不那么糟糕