Just another documentation theme compatible with GitHub Pages
This theme is inspired by sphinx-rtd-theme and refactored with:
remote_theme: rundocs/jekyll-rtd-themeYou can generate with the same files and folders from rundocs/starter-slim
Documentation that can guide how to create with Github pages, please refer to rundocs.io for details
- 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)
| 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 sortreadme_index:
with_frontmatter: truemeta:
key1: value1key2: value2...google:
gtag:
adsense:
mathjax: # this will prased to json, default: {}mermaid:
custom: # mermaid linkinitialize: # this will prased to json, default: {}scss: # also _includes/extra/styles.scssscript: # also _includes/extra/script.jstranslate:
# shortcodesdanger:
note:
tip:
warning:
# 404not_found:
# copyrightrevision:
# searchsearching:
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-mentionsThe theme is available as open source under the terms of the MIT License