搜索bookdown / bookdown
提供类似 DocBook 的 Markdown 文件渲染。
Requires
- php: >=5.6.0
- aura/cli: ~2.0
- aura/html: ~2.0
- aura/view: ~2.0
- bookdown/themes: ~1.0
- league/commonmark: ~0.0
- psr/log: ~1.0
Requires (Dev)
README
Bookdown 使用 Markdown 和 JSON 文件而不是 XML 来生成类似 DocBook 的 HTML 输出。
Bookdown 特别适合将项目文档发布到 GitHub Pages。
更多关于它的信息请访问 http://bookdown.io。
当前工作
tobiju/bookdown-bootswatch-templates 现已包含在 Bookdown 中。您可以通过在您的 bookdown.json 中设置 "template": "bookdown/themes", 来使用它。
模板
这是一个自定义 bookdown.io 模板列表
测试
在 composer install 之后运行测试，请在包根目录下执行 ./vendor/bin/phpunit。
待办事项
(按顺序排列。)
-
新的
bookdown.json元素-
"numbering"：指示在此级别如何编号页面（十进制、大写字母、小写字母、大写罗马数字、小写罗马数字） -
"authors"：书籍作者的姓名、备注、电子邮件和网站 -
"editors"：书籍编辑的姓名、备注、电子邮件和网站 -
"beforeToc"：指示放置在索引页上 TOC 之前的 Markdown 文件 -
"afterToc"：指示放置在索引页上 TOC 之后的 Markdown 文件 -
"subtitle"：指示索引页上的副标题
-
-
导航元素
-
当前级别的兄弟侧边栏
-
当前页面的父级面包屑导航
-
-
功能
-
自动将 "生成日期/时间" 值添加到根配置对象中，并在根页面上显示
-
在根页面上显示作者、编辑等
-
一个命令，用于将 PHPDocumentor 结构.xml 文件转换为 Bookdown 原始结构（Markdown 文件 + bookdown.json 文件）
-
一个过程，用于重写生成页面的链接（这是针对从多个不同来源收集的书籍，以及将原始
*.md链接更改为目标*.html链接） -
预处理和后处理行为以复制和/或删除站点文件
-
将根页视为与其他索引不同，允许它成为网站的漂亮“首页”
-