Core libraries for Bookdown generation.
PHP
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin make the bin more like a real executable Feb 28, 2015
src hhvm, heaven help us, is case-sensitve on the class name May 18, 2018
templates
tests Fix problems with href anchors Aug 13, 2017
.gitignore
.scrutinizer.yml add travis and scrutinizer Mar 1, 2015
.travis.yml Add bookdown themes as composer dependency Jul 30, 2017
CHANGELOG.md whitespace change May 28, 2018
CONTRIBUTING.md update guidelines Mar 4, 2016
LICENSE.md
README.md Add bookdown themes as composer dependency Jul 30, 2017
composer.json Add bookdown themes as composer dependency Jul 30, 2017
phpunit.php update tests, and only display last error line Feb 28, 2015
phpunit.xml.dist add whitelist for coverage reporting May 20, 2017

README.md

Bookdown

Scrutinizer Code Quality Code Coverage Build Status

Bookdown generates DocBook-like HTML output using Markdown and JSON files instead of XML.

Bookdown is especially well-suited for publishing project documentation to GitHub Pages.

Read more about it at http://bookdown.io.

Current Work

tobiju/bookdown-bootswatch-templates is now part of Bookdown. You can use it by setting the "template": "bookdown/themes", in your bookdown.json

Templates

This is a list of custom bookdown.io templates

Tests

To run the tests after composer install, issue ./vendor/bin/phpunit at the package root.

Todo

(In no particular order.)

  • new bookdown.json elements

    • "numbering": indicates how to number the pages at this level (decimal, upper-alpha, lower-alpha, upper-roman, lower-roman)

    • "authors": name, note, email, and website of book authors

    • "editors": name, note, email, and website of book editors

    • "beforeToc": indicates a Markdown file to place on the index page before the TOC

    • "afterToc": indicates a Markdown file to place on the index page after the TOC

    • "subtitle": indicates a subtitle on an index page

  • navigational elements

    • sidebar of siblings at the current level

    • breadcrumb-trail of parents leading to the current page

  • features

    • Automatically add a "date/time generated" value to the root config object and display on the root page

    • Display authors, editors, etc. on root page

    • A command to take a PHPDocumentor structure.xml file and convert it to a Bookdown origin structure (Markdown files + bookdown.json files)

    • A process to rewrite links on generated pages (this is for books collected from multiple different sources, and for changing origin *.md links to target *.html links)

    • Pre-process and post-process behavior to copy and/or remove site files

    • Treat the root page as different from other indexes, allow it to be a nice "front page" for sites