Port of the Read the Docs theme to Jekyll that can be used with GitHub Pages.
The theme documentation is also the live demo:
The original Read The Docs theme was created for Sphinx, and so it is designed specifically for documentation. Combined with GitHub Pages it's a great and easy way to document your projects.
Check out the 🚀 quick start guide to see how easy it is to get started!
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
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!
Bug reports and pull requests are welcome on GitHub at https://github.com/carlosperate/jekyll-theme-rtd.
For information about contributing, see the developer documentation.
This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
This theme is based on the MkDocs
readthedocs port.
Copyright © 2014, Tom Christie, all rights reserved, and released under the
BSD 2-Clause "Simplified" License.
The theme modifications to port it to Jekyll can be seen in this diff, and this project is also released under the BSD 2-Clause "Simplified" License.