Skip to content

Latest commit

 

History

History
137 lines (105 loc) · 4.94 KB

README.md

File metadata and controls

137 lines (105 loc) · 4.94 KB

jekyll-theme-read-the-docs

jsDelivr visitors CodeQL Advanced Umami - GDPR compliant alternative to Google Analytics License EUPL 1.2 Become a sponsor to JV-conseil Follow JV conseil on StackOverflow Follow JVconseil on Twitter Follow JVconseil on Mastodon Follow JV conseil on GitHub

Read the Docs 📖 like Jekyll Theme for GitHub Pages

What it does?

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

Quick start

remote_theme: https://github.com/JV-conseil/jekyll-theme-read-the-docs

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

Usage

Documentation that can guide how to create with Github pages, please refer to rundocs/jekyll-rtd-theme 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:
  site_verification:

# GDPR compliant alternative to Google Analytics
mouseflow:
  project_api_key:

posthog:
  project_api_key:

telemetry:
  app_id:
  user_identifier:

umami:
  website_id:

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

# NOTE: mermaid custom link are no longer supported
# instead mermaid is updated to the lastest version
# available through cdn.jsdelivr.net
# 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

Sponsorship

If this project helps you, you can offer me a cup of coffee ☕️ :-)

Become a sponsor to JV-conseil