RedDocs Researcher Documentation

Template for lab and code documentation

TLDR

The RedDocs template is intended for researchers to use to easily deploy lab and code documentation! This is a Jekyll site, meaning that it is incredibly easy to contribute to. How easy?

• adding a news item means adding a markdown document to the _posts/news folder
• the core docs, which are rendered automatically along with navigation, are also markdown files in the _docs folder
• the site renders automatically on a push to the gh-pages branch of the repo, no additional building or continuous integration is necessary. This also means you can serve the docs in the same repo as the code.

RedDocs is a template you can easily customize for your code and lab documentation, and publish on Github pages. You can preview the theme, or go directly to download.

QuickStart

Clone, make changes to files in _docs and _config.yml and push to Github! More specifically:

      git clone https://github.com/researchapps/template-jekyll-docs
      cd template-jekyll-docs

1. Option 1: Docker

Download docker, download the template to a folder, and run a container:

      docker run --label=jekyll --volume=$(pwd):/srv/jekyll -it -p 127.0.0.1:4000:4000 jekyll/jekyll

Then go to 127.0.0.1:4000/template-jekyll-docs in your browser to see the site! Make changes, add the files to your github folder (either the master branch of your user or organization repo (a repo named in the format myusername.github.io) or the gh-pages branch of another repo, which will appear at myusername.github.io/reponame.

2. Option 2: Run Locally

Install Jekyll and then run with:

      jekyll serve

Need help?

Check out the demo, and for feature requests please submit an issue. This is a work in progress, and much change is expected. Specifically:

• What functions or content formatting would you like to see for examples?
• What third party integrations would be useful?
• What can we describe better for setting up or changing content?

Special Thanks

Huge props to mkdocs-material by squidfunk the base material design template that we converted to Jekyll, and to @killian for getting us started with the hugo version!