Codecheck Documentation & Website

Welcome to Codecheck's Organization Documentation Repo!
We use Mkdocs to build the site using only Markdown, and we host it by pushing the built HTML pages to GitHub Pages.

This page is live here. If you just want to view our documentation, I recommend the live page.

Get Started

If you want to work on the site, you will want to install and run a local dev copy of it.

1. Install all dependencies.
2. git clone the contents of this repo.
3. cd [directory of clone]/source && mkdocs serve
4. Access http://localhost:8000/
5. Yatta, you're ready!

Dependencies

• Python3 & Pip3
• Mkdocs (pip3 install mkdocs)

Instructions

• All of the source files are located in /source.
• You can mkdocs serve to run and view the site locally.
• When you want to generate the static pages:
• First, go to /source and python3 build.py.
• The static pages will be generated into ./source/site.
• Move all the files in /source/site to the top. Remove any old files.