bookdown / project
Bookdown项目的骨架。
1.0.0
2017-05-21 15:08 UTC
Requires
- bookdown/bookdown: ~1.0
This package is auto-updated.
Last update: 2024-09-11 04:41:00 UTC
README
这是一个Bookdown生产项目的骨架,旨在通过GitHub Pages进行发布。
首先,克隆你想要工作的仓库,称为{$REPO}
。这可能是一个用户/组织仓库(organization.github.io
)或GitHub项目的gh-pages
分支。
然后使用composer将Bookdown项目作为{$REPO}
内部的子目录安装。我们建议使用_bookdown
,因为GitHub Pages不会发布以下划线开头的目录。
cd {$REPO}
composer create-project -s dev bookdown/project _bookdown
cd _bookdown
生成示例项目
./vendor/bin/bookdown book/bookdown.json
这将在{$REPO}
的根目录中生成示例HTML文件。
要浏览示例HTML,运行内置的PHP服务器
php -S localhost:8080 -t {$REPO}
编辑templates/head.php
文件以修改所有生成的文件的<head>
部分。
编辑book/bookdown.json
文件以添加你自己的book/
内容,包括Markdown和其他bookdown.json
文件。
你可能希望将以下行添加到{$REPO}/.gitignore
/_bookdown/vendor
然后使用git add
添加_bookdown/
目录以及生成的文件,并推送以发布。