Plugin Overview

Already have a Just The Docs site? Include these plugins in your Gemfile and _config.yml and you’re done!

# Gemfile
group :jekyll_plugins do
        gem "jekyll-hover-popup" # Link hovering preview windows
        gem "jekyll-jtd-toc-nav" # Table of Contents in the navigation bar
        gem "jekyll-dice-tray" # Dice tray with clickable dice notation recognition
        gem "jekyll-image-links" # Custom image-map features
        gem "rpg-callouts" # additional callout formatting options 
        gem "dark-dungeons-theme" # dark overlay for the default theme
end
# _config.yml
plugins: 
  - jekyll-jtd-toc-nav 
  - jekyll-dice-tray
  - jekyll-hover-popup
  - jekyll-image-links
  - rpg-callouts 
  - dark-dungeons-theme

Hover Popup Previews

Features

  • Preview windows for internal links
  • Pin windows by holding the SHIFT key
  • Move and resize by draging
  • Minimize or expand by double clicking the title bar

Dice Tray

GitHub dice-tray Ruby Gem jekyll-dice-tray

Features

  • Automatic dice notation links: 2d6, d20+1, 2-in-6, d6 + d8 (take highest result)
  • Type your own
  • History
  • Automatic dice table results (example below)


d6 Code Name Blog
1 Doctor Worm Rise Up Comus
2 V for Valeria Valeria Loves
3 Big D Energy I Cast Light
4 Oakcat Among Cats and Books
5 W. F. Sandshrew Prismatic Wasteland
6 1/2 HD Dragon Explorer’s Design

Table of Contents Navigation

Features

By default, Just The Docs doesn’t include document headers in the side navigation bar. This plugin injects the table of contents into the navigation bar with collapsible links.

TOC in Nav

Features

  • Click a region to navigate to an internal or external link
  • Optional region labels overlaid on the image
  • Optional Dynamic Map Viewer button with zoom, pan, and region highlighting
  • Automatic point rescaling for variable image dimensions (i.e. width: 50%)
  • Works natively with the preview window plug-in

Custom image maps

RPG Callouts

GitHub rpg-callouts Ruby Gem rpg-callouts

Features

  • Adventure-ready callout styles: monster, monster-no-title, and item
  • Merges definitions into Just the Docs callouts at build time
  • Site _config.yml wins on name clashes
  • In-memory only — nothing is copied into the site source

Goblin

AC 6 [13], HD 1-1 (3hp), Att 1 × spear (1d6)

Silver Key

Opens the locked door in area 3.

Dark Dungeons Theme

Features

  • Dark Dungeons color scheme overlay for Just the Docs
  • Leaves site title, favicon, navigation, and page content unchanged

Inspired by the Designing Dungeons Course.