Read The Docs Theme for Jekyll and GitHub Pages

This is a port of the Read The Docs theme to Jekyll, so that it can be used with GitHub Pages.

You are previewing the theme right now, as you navigate this documentation:

The original Read The Docs theme was created for the Sphinx documentation generator, and so it is designed specifically for docs.

Combined with GitHub Pages it’s a great and easy way to document your projects!

What Can You Find Around Here

• Check out the Quick Start Guide to get up and running.
• If some of the terms thrown around here don’t make a lot of sense, check out the What is All This? (FAQs) page.
• To find out more about all the theme available options see the Theme Configuration and the Pages Configuration pages.

🚧 Warning!

This theme is currently a Work-In-Progress but, while some things might be broken, it should be already usable.

Missing features are listed in the GitHub issues with the to-do label, and any known issues are listed with the bug label.

Contributions are very welcomed!