https://github.com/carlosperate/jekyll-theme-rtd
Port of the Read the Docs theme to Jekyll to use with GitHub Pages.
https://github.com/carlosperate/jekyll-theme-rtd
gh-pages github-pages github-pages-template github-pages-theme jekyll-template jekyll-theme readthedocs rtd
Last synced: 3 months ago
JSON representation
Port of the Read the Docs theme to Jekyll to use with GitHub Pages.
- Host: GitHub
- URL: https://github.com/carlosperate/jekyll-theme-rtd
- Owner: carlosperate
- License: bsd-2-clause
- Created: 2019-10-20T15:30:49.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2026-02-24T22:27:45.000Z (4 months ago)
- Last Synced: 2026-02-24T22:58:12.811Z (4 months ago)
- Topics: gh-pages, github-pages, github-pages-template, github-pages-theme, jekyll-template, jekyll-theme, readthedocs, rtd
- Language: HTML
- Homepage: https://carlosperate.github.io/jekyll-theme-rtd
- Size: 6.26 MB
- Stars: 59
- Watchers: 3
- Forks: 85
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Read The Docs Theme for Jekyll and GitHub Pages
Port of the Read the Docs theme to Jekyll that can be used with GitHub Pages.
The [theme documentation](https://carlosperate.github.io/jekyll-theme-rtd) is
also the live demo:
[](https://carlosperate.github.io/jekyll-theme-rtd)
The original [Read The Docs](https://sphinx-rtd-theme.readthedocs.io)
theme was created for [Sphinx](https://www.sphinx-doc.org/), and so it is
designed specifically for documentation.
Combined with [GitHub Pages](https://pages.github.com) it's a great and easy
way to document your projects.
Check out the [🚀 quick start guide](https://carlosperate.github.io/jekyll-theme-rtd/quickstart.html)
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](https://lunrjs.com/)
- ✅ Source code highlighting using the [highlight.js](https://highlightjs.org)
- ✅ Specifically developed to be compatible with GitHub Pages
- ✅ SEO-friendly meta tags and canonical URLs
- ✅ Configurable with custom options in `_config.yml` and front matter
- 🧑💻 TODO: Social media preview images
- 🧑💻 TODO: Admonition notes
### 🚧 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.1.0`
Missing features are listed in the GitHub issues with the
[enhancement](https://github.com/carlosperate/jekyll-theme-rtd/issues?q=is%3Aissue%20state%3Aopen%20label%3Aenhancement)
or [new feature](https://github.com/carlosperate/jekyll-theme-rtd/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22new%20feature%22)
labels, and any known issues are listed with the
[bug](https://github.com/carlosperate/jekyll-theme-rtd/issues?q=is%3Aissue+is%3Aopen+label%3Abug)
label.
Contributions are very welcomed!
## 👨👩👧👦 Contributing
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](https://carlosperate.github.io/jekyll-theme-rtd/dev.html).
This project is intended to be a safe, welcoming space for collaboration, and
contributors are expected to adhere to the
[Contributor Covenant](http://contributor-covenant.org) code of conduct.
## ⚖️ License
This theme is based on the [MkDocs](https://github.com/mkdocs/mkdocs)
[`readthedocs` port](https://github.com/mkdocs/mkdocs/tree/1.0.4/mkdocs/themes/readthedocs).
Copyright © 2014, Tom Christie, all rights reserved, and released under the
[BSD 2-Clause "Simplified" License](LICENSE).
The theme modifications to port it to Jekyll can be seen
[in this diff](https://github.com/carlosperate/jekyll-theme-rtd/compare/dddce9f13fde24c03aee4533158c43091120d47e...main),
and this project is also released under the
[BSD 2-Clause "Simplified" License](LICENSE).