# 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)
[![](https://badges.gitter.im/rundocs/jekyll-rtd-theme.svg)][gitter]

GitHub-flavored docs theme for Jekyll, based on sphinx_rtd_theme

<img class="shadow-box" width="50%" alt="jekyll-rtd-theme" src="https://user-images.githubusercontent.com/68011645/89026666-ad3a8680-d35b-11ea-9f4b-d3fe26ae12ed.png">

## Quick start
```yml
remote_theme: rundocs/jekyll-rtd-theme
```
You can [generate](https://github.com/rundocs/starter-slim/generate) with the same files and folders from [rundocs/starter-slim](https://github.com/rundocs/starter-slim/)

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

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

## 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
[gitter]: https://gitter.im/rundocs/jekyll-rtd-theme?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge