Contents

# jekyll-rtd-theme
[![](https://github.com/rundocs/jekyll-rtd-theme/workflows/CI/badge.svg)][repository]
[![](https://img.shields.io/gem/v/jekyll-rtd-theme)][rubygem]
[![](https://img.shields.io/gem/dt/jekyll-rtd-theme)][rubygem]
[![](https://data.jsdelivr.com/v1/package/gh/rundocs/jekyll-rtd-theme/badge)][cdn]
[![](https://www.codefactor.io/repository/github/rundocs/jekyll-rtd-theme/badge)][codefactor]
[![](https://img.shields.io/badge/featured%20on-JekyllThemes-red.svg)](https://jekyll-themes.com)

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

![][demo]

## 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][issues] for a list of proposed features (and known issues).

## Documents
For full documentation, see: [https://rundocs.github.io/jekyll-rtd-theme][site]

## The License
The theme is available as open source under the terms of the [MIT License][license].


[repository]: https://github.com/rundocs/jekyll-rtd-theme
[issues]: https://github.com/rundocs/jekyll-rtd-theme/issues
[license]: https://github.com/rundocs/jekyll-rtd-theme/blob/master/LICENSE
[site]: https://rundocs.github.io/jekyll-rtd-theme
[rubygem]: https://rubygems.org/gems/jekyll-rtd-theme
[cdn]: https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme/
[codefactor]: https://www.codefactor.io/repository/github/rundocs/jekyll-rtd-theme
[demo]: https://user-images.githubusercontent.com/68011645/88376699-87980500-cdd0-11ea-8900-7bab8c811bc9.png

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
jekyll-rtd-theme-1.0.0	README.md
jekyll-rtd-theme-0.1.9	README.md
jekyll-rtd-theme-0.1.8	README.md
jekyll-rtd-theme-0.1.7	README.md