Dark Dungeons Theme

A visual overlay gem for Just the Docs. It applies the Dark Dungeons look (dark palette, typography, links, and callout styling) without changing your site title, favicon, navigation content, or pages.

Inspired by the Designing Dungeons Course.

Works with sites created from just-the-docs-template.

In your site's Gemfile:

gem "just-the-docs", "0.12.0"
gem "dark-dungeons-theme", path: "../designing-dungeons-theme"
# or from git:
# gem "dark-dungeons-theme", github: "sunflowermans/designing-dungeons-theme"

In _config.yml, keep Just the Docs as the theme and load this gem as a plugin:

theme: just-the-docs

plugins:
  - dark-dungeons-theme

Then:

bundle install
bundle exec jekyll serve

Loading the plugin sets color_scheme: dark-dungeons, defaults callouts_level to loud, and registers a common callout set. Your existing pages and site metadata stay the same.

These are available without extra config:

{: .note }
A short note for the reader.

Override or add callouts in _config.yml (your entries win on name clashes):

callouts:
  important:
    title: Critical
    color: red
  tip:
    title: Tip
    color: blue

dark_dungeons_theme: false

• Dark Dungeons color scheme
• Heading letter-spacing and h2 underline
• Link weight and hover color
• Sidebar link weight
• Soft tinted callout backgrounds for the default callout set
• TOC label hiding in the markdown TOC

• Favicons or logos
• Author-specific callouts (e.g. course sidebars) or icons

MIT