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

![](https://user-images.githubusercontent.com/68011645/89026666-ad3a8680-d35b-11ea-9f4b-d3fe26ae12ed.png)

## 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](https://github.com/rundocs/jekyll-rtd-theme/issues) for a list of proposed features (and known issues)

## Documents
You can view theme related [tests](https://jekyll-rtd-theme.rundocs.io), For full documentation, please refer to [https://rundocs.io](https://rundocs.io)

## The License
The theme is available as open source under the terms of the [MIT License](https://github.com/rundocs/jekyll-rtd-theme/blob/master/LICENSE).


[repository]: https://github.com/rundocs/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

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
jekyll-rtd-theme-1.1.0	README.md
jekyll-rtd-theme-1.0.5	README.md