Read The Docs Theme for Jekyll & GitHub Pages
This is a port of the Read The Docs theme to Jekyll, specifically developed 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!
Features:
- ✅ Responsive design with a collapsible sidebar navigation
- ✅ “Edit on GitHub” link for each page
- ✅ Built-in search functionality using Lunr.js
- ✅ Source code highlighting using the highlight.js
- ✅ Specifically developed to be compatible with GitHub Pages
- ✅ SEO-friendly meta tags and canonical URLs
- ✅ Configurable with custom options in
_config.ymland front matter - 🧑💻 TODO: Social media preview images
- 🧑💻 TODO: Admonition notes
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.
- The Demo Pages don’t have any documentation, but generic content to show how all the Markdown features are rendered with this theme.
- The Debug Config page documents a utility file you can copy into your site to inspect every Jekyll & Liquid variable at build time.
🚧 Work in Progress!
This theme is currently being developed but v1.0 is already usable and released. Some features are still missing and breaking changes (mostly config names and default values) will be released as major uprevs.
So it is recommended to lock the version of the theme to a specific version
in the _config.yml file: remote_theme: carlosperate/jekyll-theme-rtd@v1.0.0
Missing features are listed in the GitHub issues with the enhancement or new feature labels, and any known issues are listed with the bug label.
Contributions are very welcomed!