What this page shows

  • Short summary at the top for quick scanning.
  • Headings that make sense in a table of contents.
  • Internal links like Getting Started.
  • Code blocks, lists, and a small table.

Quick facts

Field Value
Status Draft
Owner You
Last edit 2024-11-02
Tags sample, docs, howto

Steps

  1. Create a new file in _wiki/ with front matter: 
    ---
title: My Topic
summary: One-liner so readers know what this covers.
tags: [tag1, tag2]
---
  2. Add content using Markdown. Keep sections short and headed.
  3. Link to related wiki pages: [See also](/wiki/getting-started/).
  4. To hide a child page from the main index, set hide_in_index: true. Optionally add parent: slug and permalink: /wiki/parent/child/ if you want a nested-looking URL.

Parent/child example

Use this pattern for child pages you want hidden from /wiki/ but still reachable and searchable:

---
title: Child Page Title
summary: Short summary for search and cards.
parent: parent-slug
hide_in_index: true
permalink: /wiki/parent-slug/child-page/
tags: [child, example]
category: general
subcategory: basics
date: 2025-01-01
---

Link to it with [Child Page](/wiki/parent-slug/child-page/).

Code example

# Run the site locally (from repo root)
export GEM_HOME=$PWD/.gems GEM_PATH=$PWD/.gems PATH=$PWD/.gems/bin:$PATH
bundle exec jekyll serve --livereload

# Sample Ruby snippet
def hello(name)
  "Hello, #{name}!"
end

Callout

Tip: Use summary and tags in front matter; they can be surfaced in lists or search.

  • Getting Started
  • Add your own page in _wiki/your-topic.md, then check it at /wiki/your-topic/.