Download the PHP package phly/bookdown2mkdocs without Composer
On this page you can find all versions of the php package phly/bookdown2mkdocs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download phly/bookdown2mkdocs
More information about phly/bookdown2mkdocs
Files in phly/bookdown2mkdocs
Download phly/bookdown2mkdocs
More information about phly/bookdown2mkdocs
Files in phly/bookdown2mkdocs
Vendor phly
Package bookdown2mkdocs
Short Description Tool for converting bookdown.json to mkdocs.yml for publishing bookdown docs to rtfd.org
License BSD-2-Clause
Package bookdown2mkdocs
Short Description Tool for converting bookdown.json to mkdocs.yml for publishing bookdown docs to rtfd.org
License BSD-2-Clause
Please rate this library. Is it a good library?
Informations about the package bookdown2mkdocs
Bookdown2Mkdocs
Convert your bookdown.json
files to mkdocs.yml
so that you can publish
documentation to rtfd.org:
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 projectREADME.md
if such a symlink does not exist. This is because you cannot haveindex
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 to install the tool:
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
[<bookdown-path>]
: 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
All versions of bookdown2mkdocs with dependencies
PHP Build Version
Package Version
Requires
php Version
>=5.5
symfony/yaml Version ^2.7
zfcampus/zf-console Version ^1.2
zendframework/zend-filter Version ^2.5
symfony/yaml Version ^2.7
zfcampus/zf-console Version ^1.2
zendframework/zend-filter Version ^2.5
The package phly/bookdown2mkdocs contains the following files
Loading the files please wait ....