rundocs / Jekyll Rtd Theme
Licence: mit
Just another documentation theme compatible with GitHub Pages
Stars: â 92
Labels
Projects that are alternatives of or similar to Jekyll Rtd Theme
Just The Docs
A modern, high customizable, responsive Jekyll theme for documention with built-in search.
Stars: â 3,747 (+3972.83%)
Mutual labels: documentation, jekyll-theme, github-pages, scss
Docsify
đ A magical documentation site generator.
Stars: â 19,310 (+20889.13%)
Mutual labels: documentation, docs, github-pages, documentation-tool
Reverie
đ¨ A ridiculously elegant Jekyll theme.
Stars: â 442 (+380.43%)
Mutual labels: jekyll-theme, github-pages, github-page, scss
Zeal
Offline documentation browser inspired by Dash
Stars: â 9,164 (+9860.87%)
Mutual labels: documentation, docs, documentation-tool
Wowchemy Hugo Modules
đĨ Hugo website builder, Hugo themes & Hugo CMS. No code, build with widgets! ååģēå¨įēŋč¯žį¨īŧåĻæ¯įŽåæååįŊįĢã
Stars: â 6,093 (+6522.83%)
Mutual labels: static-site-generator, github-pages, documentation-tool
Devdocs
API Documentation Browser
Stars: â 27,208 (+29473.91%)
Mutual labels: documentation, docs, documentation-tool
Alembic
âī¸ A Jekyll boilerplate theme designed to be a starting point for any Jekyll website
Stars: â 501 (+444.57%)
Mutual labels: jekyll-theme, github-pages, scss
Jekyll Theme Chirpy
A minimal, sidebar, responsive web design Jekyll theme that focuses on text presentation.
Stars: â 773 (+740.22%)
Mutual labels: jekyll-theme, github-pages, scss
Forty Jekyll Theme
A Jekyll version of the "Forty" theme by HTML5 UP.
Stars: â 695 (+655.43%)
Mutual labels: static-site-generator, jekyll-theme, scss
Pdoc
API Documentation for Python Projects
Stars: â 853 (+827.17%)
Mutual labels: documentation, docs, documentation-tool
Garth
đĨ A really basic theme for Jekyll
Stars: â 85 (-7.61%)
Mutual labels: jekyll-theme, github-pages, scss
Pdoc
đ âĄī¸ đ Auto-generate API documentation for Python projects
Stars: â 604 (+556.52%)
Mutual labels: documentation, docs, documentation-tool
Jekyll Uno
Jekyll-Uno - a minimal, responsive theme for Jekyll based on Uno for Ghost
Stars: â 559 (+507.61%)
Mutual labels: jekyll-theme, github-pages, scss
Docpht
With DocPHT you can take notes and quickly document anything and without the use of any database.
Stars: â 90 (-2.17%)
Mutual labels: documentation, docs, documentation-tool
Jekyll Theme Basically Basic
Your new Jekyll default theme
Stars: â 524 (+469.57%)
Mutual labels: jekyll-theme, github-pages, scss
Cayman
Cayman is a Jekyll theme for GitHub Pages
Stars: â 719 (+681.52%)
Mutual labels: jekyll-theme, github-pages, scss
App
Fast and searchable Ruby docs
Stars: â 47 (-48.91%)
Mutual labels: documentation, docs, documentation-tool
Vuesence Book
Minimalistic Vue.js based documentation system component
Stars: â 48 (-47.83%)
Mutual labels: documentation, docs, documentation-tool
Docnado
Rapid documentation tool that will blow you away...
Stars: â 67 (-27.17%)
Mutual labels: documentation, static-site-generator, docs
Hydeout
A refreshed version of Hyde for Jekyll 3.x and 4.x
Stars: â 448 (+386.96%)
Mutual labels: jekyll-theme, github-pages, scss
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:
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
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].