Contents

# jekyll-rtd-theme

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

Opinionated github flavored documentation theme for open source projects, with few options, just use it!

# Waiting for your contribution 2.0

## 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/)

## Options

```yml
title: Your awesome title
lang: en
description: Write an awesome description for your new site here

# plugin options
readme_index:
  with_frontmatter: true


# optional settings
meta:
  key1: value1
  key2: value2
  .
  .
  .

google:
  gtag:
  adsense:

mermaid:
  custom: # mermaid link
  initialize: # mermaid options


# optional plugins
plugins:
  - jemoji
  - jekyll-avatar
  - jekyll-mentions
```

## The license

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

Version data entries

1 entries across 1 versions & 1 rubygems

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