2017 © Pedro Peláez
 

library bookdown

Provides DocBook-like rendering of Markdown files.

image

bookdown/bookdown

Provides DocBook-like rendering of Markdown files.

  • Monday, May 28, 2018
  • by pmjones
  • Repository
  • 11 Watchers
  • 75 Stars
  • 14,423 Installations
  • PHP
  • 13 Dependents
  • 0 Suggesters
  • 9 Forks
  • 4 Open issues
  • 22 Versions
  • 7 % Grown

The README.md

Bookdown

Scrutinizer Code Quality Code Coverage Build Status, (*1)

Bookdown generates DocBook-like HTML output using Markdown and JSON files instead of XML., (*2)

Bookdown is especially well-suited for publishing project documentation to GitHub Pages., (*3)

Read more about it at http://bookdown.io., (*4)

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, (*5)

Templates

This is a list of custom bookdown.io templates * bdudelsack/bookdown-template, (*6)

Tests

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

Todo

(In no particular order.), (*8)

  • new bookdown.json elements, (*9)

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

    • "authors": name, note, email, and website of book authors, (*11)

    • "editors": name, note, email, and website of book editors, (*12)

    • "beforeToc": indicates a Markdown file to place on the index page before the TOC, (*13)

    • "afterToc": indicates a Markdown file to place on the index page after the TOC, (*14)

    • "subtitle": indicates a subtitle on an index page, (*15)

  • navigational elements, (*16)

    • sidebar of siblings at the current level, (*17)

    • breadcrumb-trail of parents leading to the current page, (*18)

  • features, (*19)

    • Automatically add a "date/time generated" value to the root config object and display on the root page, (*20)

    • Display authors, editors, etc. on root page, (*21)

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

    • 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), (*23)

    • Pre-process and post-process behavior to copy and/or remove site files, (*24)

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

The Versions

28/05 2018

1.x-dev

1.9999999.9999999.9999999-dev https://github.com/bookdown/Bookdown.Bookdown

Provides DocBook-like rendering of Markdown files.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Bookdown.Bookdown Contributors

documentation markdown static site docbook manual

28/05 2018

1.1.0

1.1.0.0 https://github.com/bookdown/Bookdown.Bookdown

Provides DocBook-like rendering of Markdown files.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Bookdown.Bookdown Contributors

documentation markdown static site docbook manual

18/05 2018

dev-md-hrefs-to-html

dev-md-hrefs-to-html https://github.com/bookdown/Bookdown.Bookdown

Provides DocBook-like rendering of Markdown files.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Bookdown.Bookdown Contributors

documentation markdown static site docbook manual

29/07 2017

2.x-dev

2.9999999.9999999.9999999-dev https://github.com/bookdown/Bookdown.Bookdown

Provides DocBook-like rendering of Markdown files.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Bookdown.Bookdown Contributors

documentation markdown static site docbook manual

29/07 2017

dev-revert-62-feature/addBookdownThemesAsDefaultTheme

dev-revert-62-feature/addBookdownThemesAsDefaultTheme https://github.com/bookdown/Bookdown.Bookdown

Provides DocBook-like rendering of Markdown files.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Bookdown.Bookdown Contributors

documentation markdown static site docbook manual

21/05 2017

1.0.0

1.0.0.0 https://github.com/bookdown/Bookdown.Bookdown

Provides DocBook-like rendering of Markdown files.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Bookdown.Bookdown Contributors

documentation markdown static site docbook manual

25/04 2017

dev-stdlog

dev-stdlog https://github.com/bookdown/Bookdown.Bookdown

Provides DocBook-like rendering of Markdown files.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Bookdown.Bookdown Contributors

documentation markdown static site docbook manual

24/04 2017

dev-utf8-json

dev-utf8-json https://github.com/bookdown/Bookdown.Bookdown

Provides DocBook-like rendering of Markdown files.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Bookdown.Bookdown Contributors

documentation markdown static site docbook manual

04/03 2016

1.0.0-beta1

1.0.0.0-beta1 https://github.com/bookdown/Bookdown.Bookdown

Provides DocBook-like rendering of Markdown files.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Bookdown.Bookdown Contributors

documentation markdown static site docbook manual

04/03 2016

dev-master

9999999-dev https://github.com/bookdown/Bookdown.Bookdown

Provides DocBook-like rendering of Markdown files.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Bookdown.Bookdown Contributors

documentation markdown static site docbook manual

04/03 2016

0.x-dev

0.9999999.9999999.9999999-dev https://github.com/bookdown/Bookdown.Bookdown

Provides DocBook-like rendering of Markdown files.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Bookdown.Bookdown Contributors

documentation markdown static site docbook manual

04/03 2016

dev-develop

dev-develop https://github.com/bookdown/Bookdown.Bookdown

Provides DocBook-like rendering of Markdown files.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Bookdown.Bookdown Contributors

documentation markdown static site docbook manual

15/06 2015

0.5.0

0.5.0.0 https://github.com/bookdown/Bookdown.Bookdown

Provides DocBook-like rendering of Markdown files.

  Sources   Download

MIT

The Requires

 

by Bookdown.Bookdown Contributors

documentation markdown static site docbook manual

19/04 2015

0.4

0.4.0.0 https://github.com/bookdown/Bookdown.Bookdown

Provides DocBook-like rendering of Markdown files.

  Sources   Download

MIT

The Requires

 

by Bookdown.Bookdown Contributors

documentation markdown static site docbook manual

06/03 2015

0.3.2

0.3.2.0 https://github.com/bookdown/Bookdown.Bookdown

Provides DocBook-like rendering of Markdown files.

  Sources   Download

BSD-2-Clause

The Requires

 

by Bookdown.Bookdown Contributors

documentation markdown static site docbook manual

05/03 2015

0.3.0

0.3.0.0 https://github.com/bookdown/Bookdown.Bookdown

Provides DocBook-like rendering of Markdown files.

  Sources   Download

BSD-2-Clause

The Requires

 

by Bookdown.Bookdown Contributors

documentation markdown static site docbook manual

05/03 2015

0.3.1

0.3.1.0 https://github.com/bookdown/Bookdown.Bookdown

Provides DocBook-like rendering of Markdown files.

  Sources   Download

BSD-2-Clause

The Requires

 

by Bookdown.Bookdown Contributors

documentation markdown static site docbook manual

03/03 2015

0.2.3

0.2.3.0 https://github.com/bookdown/Bookdown.Bookdown

Provides DocBook-like rendering of Markdown files.

  Sources   Download

BSD-2-Clause

The Requires

 

by Bookdown.Bookdown Contributors

documentation markdown static site docbook manual

03/03 2015

0.2.2

0.2.2.0 https://github.com/bookdown/Bookdown.Bookdown

Provides DocBook-like rendering of Markdown files.

  Sources   Download

BSD-2-Clause

The Requires

 

by Bookdown.Bookdown Contributors

documentation markdown static site docbook manual

01/03 2015

0.2

0.2.0.0 https://github.com/bookdown/Bookdown.Bookdown

Provides DocBook-like rendering of Markdown files.

  Sources   Download

BSD-2-Clause

The Requires

 

by Bookdown.Bookdown Contributors

documentation markdown static site docbook manual

01/03 2015

0.2.1

0.2.1.0 https://github.com/bookdown/Bookdown.Bookdown

Provides DocBook-like rendering of Markdown files.

  Sources   Download

BSD-2-Clause

The Requires

 

by Bookdown.Bookdown Contributors

documentation markdown static site docbook manual

01/03 2015

0.1

0.1.0.0 https://github.com/bookdown/Bookdown.Bookdown

Provides DocBook-like rendering of Markdown files.

  Sources   Download

BSD-2-Clause

The Requires

 

by Bookdown.Bookdown Contributors

documentation markdown static site docbook manual