PHPackages                             bookdown/project - 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/project

ActiveProject[Parsing & Serialization](/categories/parsing)

bookdown/project
================

A skeleton Bookdown project.

1.0.0(8y ago)112474MITPHP

Since May 21Pushed 8y ago2 watchersCompare

[ Source](https://github.com/bookdown/Bookdown.Project)[ Packagist](https://packagist.org/packages/bookdown/project)[ Docs](https://github.com/bookdown/Bookdown.Project)[ RSS](/packages/bookdown-project/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (1)Versions (2)Used By (0)

Bookdown Project
================

[](#bookdown-project)

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 `` 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.

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity20

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity63

Established project with proven stability

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

Unknown

Total

1

Last Release

3284d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/25754?v=4)[Paul M. Jones](/maintainers/pmjones)[@pmjones](https://github.com/pmjones)

---

Tags

documentationmarkdownmanualstatic-sitedocbook

### Embed Badge

![Health badge](/badges/bookdown-project/health.svg)

```
[![Health](https://phpackages.com/badges/bookdown-project/health.svg)](https://phpackages.com/packages/bookdown-project)
```

###  Alternatives

[bookdown/bookdown

Provides DocBook-like rendering of Markdown files.

8257.6k16](/packages/bookdown-bookdown)[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)[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)[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)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)