Cyclr Documentation

You can use the editor on GitHub to maintain and preview the content for your website in Markdown files.

Whenever you commit to this repository, GitHub Pages will run Jekyll to rebuild the pages in your site, from the content in your Markdown files.

Markdown

Markdown is a lightweight and easy-to-use syntax for styling your writing.

For more details see GitHub Flavored Markdown.

Setting up your GitHub Pages site locally with Jekyll

1. If you don't have Docker installed, install Docker.
2. Open the terminal.
3. On your local computer, clone the Git repository for Cyclr Documentation:

$ git clone https://github.com/cyclr/docs.git

4. Start up the application:

$ docker-compose up