Contents

# jekyll-rtd-theme

[![CI](https://github.com/rundocs/jekyll-rtd-theme/workflows/CI/badge.svg)][repository]
[![jsDelivr](https://data.jsdelivr.com/v1/package/gh/rundocs/jekyll-rtd-theme/badge)][cdn]

Opinionated github flavored documentation theme for open source projects

## 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 our website ([rundocs.io](https://rundocs.io/)) for details

### test

- Latest test document: [rundocs.github.io/jekyll-rtd-theme](https://rundocs.github.io/jekyll-rtd-theme)
- Preview debug branch, please refer to [rundocs.github.io/debug](https://rundocs.github.io/debug)

## The license

The theme is available as open source under the terms of the MIT 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

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
jekyll-rtd-theme-2.0.0.pre.beta	README.md