Just another jekyll docs theme compatible with GitHub Pages, based on sphinx_rtd_theme


Keywords
cdn, codefactor, docsify, documentation, documentation-tool, github-page, github-pages, jekyll-rtd-theme, jekyll-theme, mkdocs, readthedocs, rubygem, search-engine, search-engines, sphinx-rtd-theme, static-site-generator
License
MIT
Install
gem install jekyll-rtd-theme -v 1.0.5

Documentation

jekyll-rtd-theme

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

Features

  • Automatically generate sidebar based on directory
  • Only need one file _config.yml to configure site
  • Search engine optimized
  • Multi-language supported
  • Document search (RegExp supported)
  • Support third-party comments
  • Google, Baidu, CNZZ Analytics support

Roadmap

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

Documents

You can view theme related tests, For full documentation, please refer to https://rundocs.io

The License

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