README.md

jekyll-rtd-theme

Just another documentation theme compatible with GitHub Pages

What it does?

This theme is inspired by sphinx-rtd-theme and refactored with:

• @primer/css
• github-pages (dependency versions)

Quick start

remote_theme: rundocs/jekyll-rtd-theme

You can generate with the same files and folders from rundocs/starter-slim

Usage

Documentation that can guide how to create with Github pages, please refer to rundocs.io for details

Features

• Shortcodes (Toasts card, mermaid)
• Pages Plugins (emoji, gist, avatar, mentions)
• Auto generate sidebar
• Attribute List Definitions (Primer/css utilities, Font Awesome 4)
• Service worker (caches)
• SEO (404, robots.txt, sitemap.xml)
• Canonical Link (Open Graph, Twitter Card, Schema data)

Options

name	default value	description
title	repo name
description	repo description
url	user domain or cname
baseurl	repo name
lang	en
direction	auto	ltr or rtl
highlighter	rouge	Cannot be changed

# folders sort
readme_index:
  with_frontmatter: true

meta:
  key1: value1
  key2: value2
  .
  .
  .

google:
  gtag:
  adsense:

mathjax: # this will prased to json, default: {}

mermaid:
  custom:     # mermaid link
  initialize: # this will prased to json, default: {}

scss:   # also _includes/extra/styles.scss
script: # also _includes/extra/script.js

translate:
  # shortcodes
  danger:
  note:
  tip:
  warning:
  # 404
  not_found:
  # copyright
  revision:
  # search
  searching:
  search:
  search_docs:
  search_results:
  search_results_found: # the "#" in this translate will replaced with results size!
  search_results_not_found:

plugins:
  - jemoji
  - jekyll-avatar
  - jekyll-mentions

The license

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