Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thanhtunguet/jekyll-rtd-theme
https://github.com/thanhtunguet/jekyll-rtd-theme
Last synced: 23 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/thanhtunguet/jekyll-rtd-theme
- Owner: thanhtunguet
- License: mit
- Created: 2023-07-29T02:57:04.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2023-10-26T20:25:36.000Z (about 1 year ago)
- Last Synced: 2024-11-14T10:09:32.880Z (about 1 month ago)
- Language: SCSS
- Size: 3.45 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# jekyll-rtd-theme
Just another documentation theme compatible with GitHub Pages
## What it does?
This theme is inspired by [sphinx-rtd-theme](https://github.com/readthedocs/sphinx_rtd_theme) and refactored with:
- [@primer/css](https://github.com/primer/css)
- [github-pages](https://github.com/github/pages-gem) ([dependency versions](https://pages.github.com/versions/))
## 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/)
## Usage
Documentation that can guide how to create with Github pages, please refer to [rundocs.io](https://rundocs.io) for details
## Features
- Shortcodes (Toasts card, mermaid)
- Pages Plugins (emoji, gist, avatar, mentions)
- Auto generate sidebar
- [Attribute List Definitions](https://kramdown.gettalong.org/syntax.html#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 |
```yml
# 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