jekyll-rtd-theme

Just another documentation theme compatible with GitHub Pages, based on sphinx_rtd_theme

Notable features

Write documents directly, like docsify!
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 and sitemap.xml.
Search engine support
Commenting support
Google,Baidu,CNZZ Analytics support.
UI localized text in English(default), Chinese(中文)
And many features waiting for you to discover.

Roadmap

See the open issues for a list of proposed features (and known issues).

Documents

For full documentation, see: https://rundocs.github.io/jekyll-rtd-theme

The License

The theme is available as open source under the terms of the MIT License.