PHPackages bookdown/bookdown - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Parsing & Serialization](/categories/parsing) 4. / 5. bookdown/bookdown ActiveLibrary[Parsing & Serialization](/categories/parsing) bookdown/bookdown ================= Provides DocBook-like rendering of Markdown files. 1.1.1(7y ago)8257.6k↑52.6%12[3 issues](https://github.com/bookdown/Bookdown.Bookdown/issues)[1 PRs](https://github.com/bookdown/Bookdown.Bookdown/pulls)16MITPHPPHP >=5.6.0 Since Mar 1Pushed 4y ago9 watchersCompare [ Source](https://github.com/bookdown/Bookdown.Bookdown)[ Packagist](https://packagist.org/packages/bookdown/bookdown)[ Docs](https://github.com/bookdown/Bookdown.Bookdown)[ RSS](/packages/bookdown-bookdown/feed)WikiDiscussions 1.x Synced 1mo ago READMEChangelog (10)Dependencies (10)Versions (17)Used By (16) Bookdown ======== [](#bookdown) [![Scrutinizer Code Quality](https://camo.githubusercontent.com/31083def41aef1cc4056732572aee4ebbd54df6b757e4cbbbbf2e9e018ec942c/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f626f6f6b646f776e2f426f6f6b646f776e2e426f6f6b646f776e2f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/bookdown/Bookdown.Bookdown/?branch=master)[![Code Coverage](https://camo.githubusercontent.com/3364ab74c64d846090b4ce699a80cd5db6d7b8d8042aac410556fa046cf34f0c/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f626f6f6b646f776e2f426f6f6b646f776e2e426f6f6b646f776e2f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/bookdown/Bookdown.Bookdown/?branch=master)[![Build Status](https://camo.githubusercontent.com/0649d8f40b2d773c51db3268df20ee8e2df60268261b865beb76fceb54505d1b/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f626f6f6b646f776e2f426f6f6b646f776e2e426f6f6b646f776e2f6261646765732f6275696c642e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/bookdown/Bookdown.Bookdown/build-status/master) Bookdown generates [DocBook](http://docbook.org)-like HTML output using [Markdown](http://daringfireball.net/projects/markdown/) and JSON files instead of XML. Bookdown is especially well-suited for publishing project documentation to GitHub Pages. Read more about it at . Current Work ------------ [](#current-work) [tobiju/bookdown-bootswatch-templates](https://github.com/tobiju/bookdown-bootswatch-templates "Bootswatch styles and syntax highlighting")is now part of Bookdown. You can use it by setting the `"template": "bookdown/themes",` in your `bookdown.json` Templates --------- [](#templates) This is a list of custom bookdown.io templates - [bdudelsack/bookdown-template](https://github.com/bdudelsack/bookdown-template "Template for the bookdown project using Bootstrap and HighlightJS") Tests ----- [](#tests) To run the tests after `composer install`, issue `./vendor/bin/phpunit` at the package root. Todo ---- [](#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 ### Health Score 43 — FairBetter than 91% of packages Maintenance19 Infrequent updates — may be unmaintained Popularity44 Moderate usage in the ecosystem Community32 Small or concentrated contributor base Maturity66 Established project with proven stability Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~158 days Recently: every ~429 days Total 17 Last Release 1567d ago Major Versions 0.x-dev → 1.0.0-beta12016-03-04 1.x-dev → 2.x-dev2022-02-01 PHP version history (3 changes)0.2.3PHP >=5.4.0 1.0.0PHP >=5.6.0 2.x-devPHP ^7.4||^8.0 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/25754?v=4)[Paul M. Jones](/maintainers/pmjones)[@pmjones](https://github.com/pmjones) --- Top Contributors [![sandrokeil](https://avatars.githubusercontent.com/u/3597436?v=4)](https://github.com/sandrokeil "sandrokeil (18 commits)")[![tobiju](https://avatars.githubusercontent.com/u/14201950?v=4)](https://github.com/tobiju "tobiju (13 commits)")[![llaville](https://avatars.githubusercontent.com/u/364342?v=4)](https://github.com/llaville "llaville (3 commits)")[![pmjones](https://avatars.githubusercontent.com/u/25754?v=4)](https://github.com/pmjones "pmjones (2 commits)")[![prolic](https://avatars.githubusercontent.com/u/394428?v=4)](https://github.com/prolic "prolic (1 commits)")[![msphn](https://avatars.githubusercontent.com/u/579227?v=4)](https://github.com/msphn "msphn (1 commits)")[![harikt](https://avatars.githubusercontent.com/u/120454?v=4)](https://github.com/harikt "harikt (1 commits)")[![henrikbjorn](https://avatars.githubusercontent.com/u/19725?v=4)](https://github.com/henrikbjorn "henrikbjorn (1 commits)")[![bdudelsack](https://avatars.githubusercontent.com/u/3631456?v=4)](https://github.com/bdudelsack "bdudelsack (1 commits)") --- Tags documentationmarkdownmanualstatic-sitedocbook ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/bookdown-bookdown/health.svg) ``` [![Health](https://phpackages.com/badges/bookdown-bookdown/health.svg)](https://phpackages.com/packages/bookdown-bookdown) ``` ### Alternatives [justinwalsh/daux.io Documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly 4.6k38.1k1](/packages/justinwalsh-dauxio)[daux/daux.io Documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly 825191.0k1](/packages/daux-dauxio)[tobiju/bookdown-bootswatch-templates Bookdown.io With Bootswatch Styles And Prism Syntax Highlighting 1619.6k1](/packages/tobiju-bookdown-bootswatch-templates)[bookdown/themes Bookdown.io With Bootswatch Styles And Prism Syntax Highlighting 1135.7k1](/packages/bookdown-themes)[dniccum/nova-documentation A Laravel Nova tool that allows you to add markdown-based documentation to your administrator's dashboard. 37116.4k](/packages/dniccum-nova-documentation)[georgringer/doc Render documentation based on markdown files directly in the backend 2232.7k](/packages/georgringer-doc) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)