Creating documentation with GitHub pages

The markdown files under /docs/ of the find-my-kitten repository use GitHub pages with a remote theme defined in _config.yml.

# contents of _config.yml
title: AI, find my kitten! | Documentation
remote_theme: just-the-docs/just-the-docs
color_scheme: dark

The result is static pages running on Jekyll with the just-the-docs theme. Documentation for the theme can be found on https://just-the-docs.com/ but this page serves as a quick rundown.

Jekyll will turn any .md file into an HTML page with markdown formatting. An implicit header is defined from file contents, but it is possible to write some parameters explicitly if desired (for example, to specify a parent page for navigation). An example header (at the start of the md file) could look like the following:

---
title: Replacement for first header
parent:  Some other title
---

# Implicit title from first header that is overwritten above
Some regular markdown content...

Some notes:

• A link must be specified with angle brackets, e.g. <https://github.com/CatScanners/find-my-kitten>
• In order to link to images or other assets, prefer relative paths, e.g. ../assets/Figure_1.png if you’re in a subdirectory.