Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phly/bookdown2mkdocs
Convert bookdown.json to mkdocs.yml for syndication on rtfd.org
https://github.com/phly/bookdown2mkdocs
Last synced: about 19 hours ago
JSON representation
Convert bookdown.json to mkdocs.yml for syndication on rtfd.org
- Host: GitHub
- URL: https://github.com/phly/bookdown2mkdocs
- Owner: phly
- License: bsd-2-clause
- Created: 2015-08-20T18:15:08.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2015-08-24T20:43:17.000Z (about 9 years ago)
- Last Synced: 2024-10-11T21:41:54.374Z (26 days ago)
- Language: PHP
- Size: 121 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Bookdown2Mkdocs
Convert your `bookdown.json` files to `mkdocs.yml` so that you can publish
documentation to rtfd.org:
```bash
$ 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
>
> - 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
Use [Composer](https://getcomposer.org) to install the tool:
```bash
$ composer global require phly/bookdown2mkdocs
```
Tip: add `$HOME/.composer/vendor/bin` to your `$PATH`.
## Usage
Excecute the command in the root of your project.
> bookdown2mkdocs.php convert [] --site-name= --repo-url= --copyright-url= --copyright-author= [--mkdocs=]
### 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