Just another documentation theme compatible with GitHub Pages, based on sphinx_rtd_theme
- Write documents directly, automatically generate toctree based on directory
- Only need one file
_config.yml
to configure site - Bundled as a "theme gem" for easier installation/upgrading.
- Compatible with GitHub Pages.
- Optimized for search engines with support for Open Graph data.
- Optimized for search engines with
robots.txt
andsitemap.xml
. - Search engine (RegExp supported)
- Commenting support
- Google,Baidu,CNZZ Analytics support.
- Multi-language supported
- And many features waiting for you to discover.
See the open issues for a list of proposed features (and known issues).
For full documentation, see: https://jekyll-rtd-theme.rundocs.io
The theme is available as open source under the terms of the MIT License.