phly/bookdown2mkdocs

将 bookdown.json 转换为 mkdocs.yml 的工具，用于将 bookdown 文档发布到 rtfd.org

维护者

详细信息

github.com/phly/bookdown2mkdocs

源代码

问题

安装: 242

依赖: 0

建议者: 0

安全性: 0

星星: 0

关注者: 4

分支: 0

开放问题: 0

0.1.2 2015-08-24 20:42 UTC

Requires

BSD-2-Clause ac454e695dfee969cf8c24d668db138114732c3a

documentationbookdownmkdocs

This package is auto-updated.

Last update: 2024-09-11 14:28:05 UTC

README

将您的 bookdown.json 文件转换为 mkdocs.yml，以便您可以将文档发布到 rtfd.org

$ cd project-with-bookdown
$ path/to/bin/bookdown2mkdocs.php convert doc/bookdown.json \
> --site-name=my-project \
> --repo-url=http://example.com/project \
> --copyright-author="Me Me Me" \
> --copyright-url=http://example.com

注意事项

  • 该命令假设您的文档位于 doc/book/。
  • 该命令假设您希望渲染的文档位于 doc/html/。
  • 如果不存在这样的符号链接，该命令将创建一个指向项目的 README.md 的符号链接 doc/book/index.md。这是因为您不能在 bookdown 中有 index 页面；这些页面是为自动生成的目录保留的。
  • 对远程 bookdown.json 文件的引用将不会工作，只有本地文件。
  • 该命令 将会覆盖 mkdocs.yml。

安装

使用 Composer 安装此工具

$ composer global require phly/bookdown2mkdocs

提示：将 $HOME/.composer/vendor/bin 添加到您的 $PATH。

用法

在您的项目根目录中执行该命令。

bookdown2mkdocs.php convert [] --site-name= --repo-url= --copyright-url= --copyright-author= [--mkdocs=]

参数

  • [<bookdown-path>]：bookdown.json 的路径；如果不存在，则假设为 doc/bookdown.json
  • --site-name=：站点/项目名称；通常用作 rtfd.org 的子域名
  • --repo-url=：存储库 URI（从生成的文档中链接）
  • --copyright-url=：与版权所有者相关的 URL
  • --copyright-author=：版权所有者/作者
  • [--mkdocs=]：mkdocs 的其他默认配置，作为 JSON 字符串