docuowl:documentation文档生成器

时间:2024-04-24 23:43:00
【文件属性】:

文件名称:docuowl:documentation文档生成器

文件大小:364KB

文件格式:ZIP

更新时间:2024-04-24 23:43:00

documentation documentation-generator documentation-site documentation-website documentation-template

:owl: cu Docuowl从Markdown文件生成静态单页文档 基本原理 作为和Markdown长期致力于文档风格的支持者,我决定使用前者来创建一个漂亮的文档生成器,以输出类似于Stripe的东西。 文件组织 Docuowl将目录作为输入。 该目录应为每个部分或组有一个目录。 每个组可能都有子节,而这些子节又必须放在目录中。 每个部分都必须具有一个content.md文件(包含该部分的Frontmatter)和一个可选的sidenotes.md文件,该文件将显示在该部分的右侧。 Frontmatter必须至少包含一个Title属性,以及一个可选的ID属性,该属性包含该部分的唯一子段。 每个组都必须包含一个meta.md文件,该文件包含meta.md (如Section)和在frontmatter之后的可选内容。 例如,以以下目录树为例: . ├── 1-introduction │ 


网友评论