Skip to content

Latest commit

 

History

History
64 lines (32 loc) · 2.79 KB

README.md

File metadata and controls

64 lines (32 loc) · 2.79 KB
Raw

RedDocs Researcher Docs

Welcome to the RedDocs template for researcher 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.

img/intro.png

QuickStart

Clone, make changes to files in _docs, and push a PR to the master or gh-pages branch of this repo to be reviewed. More specifically, after you fork the repository to your username or organization:

  git clone https://github.com/<username>/red-docs-jekyll
  cd red-docs-jekyll
  1. Option 1: Docker

Download docker, download the site repository 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/red-docs-jekyll/ in your browser to see the site! Make changes, add the files to your github folder, preview and go! We can even easily add continuous integration to preview the site so others don't have to build locally.

  1. Option 2: Run Locally

Install Jekyll and then run with:

  jekyll serve

About Pages

A page is rendered with the template that has a sidebar, the one that looks like this:

img/docs.png

Any page that you add, meaning an html or markdown file in the pages folder will have the docs sidebar if you add the following to the front-end matter:

  sidebar: true

When left undefined (desired for pages like news, 404, etc), this sidebar will not include the docs.

How do the docs work?

Check out the demo to learn about how the folder of _docs is rendered automatically.

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!