Jekyll Themes
Themes
- https://jamstackthemes.dev/demo/theme/jekyll-documentation-theme-/
- https://jamstackthemes.dev/demo/theme/jekyll-aviator/
- https://github.com/just-the-docs/just-the-docs https://just-the-docs.com/
Just the Docs Theme
To use the just-the-docs theme, add this to your Gemfile:
gem "just-the-docs"
Add this to your _config.yml
# Build settings
#theme: minima
theme: just-the-docs
Footer
_includes/footer_custom.html
_config.yaml
title: IT Grimoire
email: jame_s@somesite.com
description: >- # this means to ignore newlines until "baseurl:"
Information Technology Grimoire
baseurl: "" # the subpath of your site, e.g. /blog
url: "" # the base hostname & protocol for your site, e.g. http://example.com
#twitter_username: jekyllrb
#github_username: jekyll
color_scheme: dark
theme: just-the-docs
plugins:
- jekyll-feed
nav_sort: case_insensitive
host: 0.0.0.0
port: 4000
mermaid:
# Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
version: "9.1.3"
# fix with correct UA
ga_tracking: UA-12345-12
ga_tracking_anonymize_ip: true
# requires https
enable_copy_code_button: true
Jekyll Gotcha
- sometimes you have to restart jekyll to get good rendering
jekyll serve
Pages
(Just make a page.markdown and it will render)
---
# Title, summary, and page position.
linktitle: Troubleshooting
summary: Troubleshooting Documentation
weight: 1
icon: book
icon_pack: fas
# Page metadata.
title: Troubleshooting
date:
type: book # Do not modify.
---
Posts
dir1/dir2/_posts/YEAR-MM-DD-some-title.markdown in the _posts directory
---
# Title, summary, and page position.
linktitle: "Welcome to Jekyll!"
summary: "Welcome to Jekyll!" Documentation
weight: 1
icon: book
icon_pack: fas
# Page metadata.
title: "Welcome to Jekyll!"
date:
type: book # Do not modify.
---
Other params must be on the same line or it wraps it in p tags.
CSS
- Find the $HOME/gems/gems/just-the-docs/layout/default.html page
- add the standard css include lines like normal html
- create the css file like normal, but modify the gem
\yoursitejekyllroot\vendor\bundle\ruby\3.2.0\gems\just-the-docs-0.5.4\_sass\custom\custom.scss
this didn’t work at all
/assets/css/custom.css
Javascript/Includes
<script src="/assets/js/list-compare.js"></script>