PHPackages                             phly/bookdown2mkdocs - 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. [Utility & Helpers](/categories/utility)
4. /
5. phly/bookdown2mkdocs

AbandonedArchivedLibrary[Utility & Helpers](/categories/utility)

phly/bookdown2mkdocs
====================

Tool for converting bookdown.json to mkdocs.yml for publishing bookdown docs to rtfd.org

0.1.2(10y ago)0247BSD-2-ClausePHPPHP >=5.5

Since Aug 20Pushed 9mo ago2 watchersCompare

[ Source](https://github.com/phly/bookdown2mkdocs)[ Packagist](https://packagist.org/packages/phly/bookdown2mkdocs)[ RSS](/packages/phly-bookdown2mkdocs/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (3)Versions (4)Used By (0)

Bookdown2Mkdocs
===============

[](#bookdown2mkdocs)

> ⚠️ **Archived 2025-08-17**
>
> Use at your own risk.

Convert your `bookdown.json` files to `mkdocs.yml` so that you can publish documentation to rtfd.org:

```
$ cd project-with-bookdown
$ path/to/bin/bookdown2mkdocs.php convert doc/bookdown.json \
> --site-name=my-project \
> --repo-url=http://example.com/project \
> --copyright-author="Me Me Me" \
> --copyright-url=http://example.com
```

> ## Caveats
>
> [](#caveats)
>
> - The command assumes that your documentation is in `doc/book/`.
> - The command assumes that you want rendered documentation in `doc/html/`.
> - The command will create a symlink `doc/book/index.md` pointing to the project `README.md` if such a symlink does not exist. This is because you cannot have `index` pages in bookdown; those are reserved for auto-generated TOCs.
> - References to remote `bookdown.json` files will not work, only local files.
> - The command *will* overwrite `mkdocs.yml`.

Installation
------------

[](#installation)

Use [Composer](https://getcomposer.org) to install the tool:

```
$ composer global require phly/bookdown2mkdocs
```

Tip: add `$HOME/.composer/vendor/bin` to your `$PATH`.

Usage
-----

[](#usage)

Excecute the command in the root of your project.

> bookdown2mkdocs.php convert \[\] --site-name= --repo-url= --copyright-url= --copyright-author= \[--mkdocs=\]

### Arguments

[](#arguments)

- `[]`: Path to bookdown.json; if not present, assumes doc/bookdown.json
- `--site-name=`: Site/project name; typically used as the subdomain in rtfd.org
- `--repo-url=`: Repository URI (linked from generated docs)
- `--copyright-url=`: URL associated with the copyright holder
- `--copyright-author=`: Copyright holder/author
- `[--mkdocs=]`: Additional default configuration for mkdocs, as a JSON string

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance41

Moderate activity, may be stable

Popularity12

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity50

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

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 ~2 days

Total

3

Last Release

3920d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/25943?v=4)[Matthew Weier O'Phinney](/maintainers/weierophinney)[@weierophinney](https://github.com/weierophinney)

---

Top Contributors

[![weierophinney](https://avatars.githubusercontent.com/u/25943?v=4)](https://github.com/weierophinney "weierophinney (7 commits)")

---

Tags

documentationmkdocsbookdown

### Embed Badge

![Health badge](/badges/phly-bookdown2mkdocs/health.svg)

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

###  Alternatives

[genericmilk/docudoodle

Generate documentation for your Laravel application using OpenAI

15120.5k](/packages/genericmilk-docudoodle)[codelicia/xulieta

Xulieta is a light php binary that lint documentation snippets

6713.3k5](/packages/codelicia-xulieta)[doxphp/doxphp

Dox for PHP, inspired by Dox for JavaScript.

502.8k2](/packages/doxphp-doxphp)

PHPackages © 2026

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