Instructions for using Manubot Rootstock for your own manuscript are still evolving.
The recommended approach is to clone this repository, as detailed here.

Manubot

Manubot is a system for writing scholarly manuscripts via GitHub.
Manubot automates citations and references, versions manuscripts using git, and enables collaborative writing via GitHub.
The Manubot Rootstock repository is a general purpose template for creating new Manubot instances, as detailed in SETUP.md.
See USAGE.md for documentation how to write a manuscript.

Please open an issue for questions related to Manubot usage, bug reports, or general inquiries.

Repository directories & files

The directories are as follows:

content contains the manuscript source, which includes markdown files as well as inputs for citations and references.
See USAGE.md for more information.

output contains the outputs (generated files) from the manubot including the resulting manuscripts.
You should not edit these files manually, because they will get overwritten.

webpage is a directory meant to be rendered as a static webpage for viewing the HTML manuscript.

Sometimes it's helpful to monitor the content directory and automatically rebuild the manuscript when a change is detected.
The following command, while running, will trigger both the build.sh and webpage.py scripts upon content changes:

sh build/autobuild.sh

Continuous Integration

Whenever a pull request is opened, Travis CI will test whether the changes break the build process to generate a formatted manuscript.
The build process aims to detect common errors, such as invalid citations.
If your pull request build fails, see the Travis CI logs for the cause of failure and revise your pull request accordingly.

Since CC BY is not ideal for code and data, certain repository components are also released under the CC0 1.0 public domain dedication (LICENSE-CC0.md).
All files matched by the following glob patterns are dual licensed under CC BY 4.0 and CC0 1.0: