包简介

A skeleton Bookdown project.

README 文档

README

This forms a skeleton Bookdown production project, with an eye toward publishing via Github Pages.

First, clone the repository you want to work in, called {$REPO}. This may be a user/organization repository (organization.github.io) or a Github project gh-pages branch.

Then use composer to install the Bookdown project as a subdirectory inside {$REPO}. We suggest _bookdown since Github Pages will not publish underscore-prefixed directories.

cd {$REPO}
composer create-project -s dev bookdown/project _bookdown
cd _bookdown

Generate the example project:

./vendor/bin/bookdown book/bookdown.json

This will generate the example HTML files at the root of {$REPO}.

To browse the example HTML, run the built-in PHP server:

php -S localhost:8080 -t {$REPO}

Edit the templates/head.php file to modify the <head> on all generated files.

Edit the book/bookdown.json file to add your own book/ content, including both Markdown and other bookdown.json files.

You may wish to add the following lines to {$REPO}/.gitignore:

/_bookdown/vendor

Then git add the _bookdown/ directory along with the generated files, and push to publish.

bookdown/project 适用场景与选型建议

bookdown/project 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 247 次下载、GitHub Stars 达 10，最近一次更新时间为 2015 年 02 月 28 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「documentation」「markdown」「docbook」「static site」「manual」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 bookdown/project 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 bookdown/project 我们能提供哪些服务？

定制开发 / 二次开发

基于 bookdown/project 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 bookdown/project 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

dg/texy 159

Texy converts plain text in easy to read Texy syntax into structurally valid (X)HTML. It supports adding of images, links, nested lists, tables and has full support for CSS. Texy supports hyphenation of long words (which reflects language rules), clickable emails and URL (emails are obfuscated again

bookdown/bookdown 82

Provides DocBook-like rendering of Markdown files.

bookdown/themes 11

Bookdown.io With Bootswatch Styles And Prism Syntax Highlighting

prooph/bookdown-template 5

Bookdown.io With Bootswatch Styles And Prism Syntax Highlighting

tobiju/bookdown-bootswatch-templates 16

Bookdown.io With Bootswatch Styles And Prism Syntax Highlighting

code-orange/jot 7

Laravel package that generates RESTful API documentation in Markdown based on PHPDoc.