A documentation theme for Jigyll. Canonical repository; mirrored to GitHub.
  • JavaScript 35.2%
  • HTML 29.3%
  • CSS 13.8%
  • SCSS 13.6%
  • Python 8.1%
Find a file
2026-11-07 18:28:23 -05:00
.impeccable chore: preserve design context for future UI work 2026-10-08 18:45:42 -04:00
_includes Rename Docifly to Docside and document tagged releases 2026-11-07 18:20:59 -05:00
_layouts Rename Docifly to Docside and document tagged releases 2026-11-07 18:20:59 -05:00
_sass Rename Docifly to Docside and document tagged releases 2026-11-07 18:20:59 -05:00
assets Rename Docifly to Docside and document tagged releases 2026-11-07 18:20:59 -05:00
docs update copy 2026-11-07 18:28:23 -05:00
evidence feat: brand Docifly and flatten documentation 2026-10-08 16:27:59 -04:00
fixtures Rename Docifly to Docside and document tagged releases 2026-11-07 18:20:59 -05:00
tools Rename Docifly to Docside and document tagged releases 2026-11-07 18:20:59 -05:00
.gitattributes Exclude development theme symlink from source archives 2026-11-07 18:23:12 -05:00
.gitignore adopt repo 2026-11-02 20:14:28 -05:00
_config.yml initial commit 2026-09-08 17:05:39 -04:00
AGENTS.md fix: clarify docs setup and file-tree layout 2026-11-07 16:33:03 -05:00
brand.yml refactor(theme): centralize color definitions 2026-10-25 14:47:28 -04:00
CONTEXT.md Rename Docifly to Docside and document tagged releases 2026-11-07 18:20:59 -05:00
DESIGN.md Rename Docifly to Docside and document tagged releases 2026-11-07 18:20:59 -05:00
PRODUCT.md Rename Docifly to Docside and document tagged releases 2026-11-07 18:20:59 -05:00
README.md Rename Docifly to Docside and document tagged releases 2026-11-07 18:20:59 -05:00

Docside

Docside is a documentation theme for Jigyll, using stock Starlight as visual reference only.

Start a new site

Install Git and Jigyll 1.13.0 or later, then create a site with Docside:

jigyll new my-docs --theme https://github.com/reidransom/docside.git
cd my-docs

The installer clones Docside into _theme/docside/.

Replace _config.yml with a minimal site configuration:

title: My documentation
theme: docside
url: ""
baseurl: ""
navigation:
  - label: Overview
    link: /
defaults:
  - scope:
      path: ""
    values:
      layout: default

Replace index.md with an overview:

---
title: Overview
permalink: /
---

Welcome to my documentation.

## Next steps

Add ordinary Markdown pages and list them in `_config.yml`.

Serve the site from its new directory:

jigyll serve --host 127.0.0.1 --port 4322

Open http://127.0.0.1:4322/. The generated site is _site/.

See Getting started for page and navigation examples, then read the guides under docs/.

Develop the theme

Theme maintainers should use the installed-consumer workflow in Developing Docside. It explains how to preview and rebuild this repository's living documentation without making a direct source build look like consumer-installation proof.

Attribution

The theme retains upstream notices beside shipped third-party assets. Stock Starlight attribution is in assets/starlight-LICENSE, and the frozen Seti file-icon inventory is covered by assets/file-tree-icons-LICENSE. Search loads the MIT-licensed MiniSearch directly from jsDelivr; its bundle is not vendored.