destiny-saga

Sample Documentation Page

This page is a kitchen-sink for Markdown features. Use it to verify how GitHub Pages (Jekyll + kramdown) renders elements so you can style them consistently.

Quick links: Overview · Typography · Lists · Code · Tables · Media · Details · Footnotes · Math


Overview

Status: Draft
Last updated: 2026-02-24
Tags: jekyll, github-pages, docs, theme

A paragraph with common inline elements: bold, italic, bold italic, strikethrough, inline code, and a link to GitHub.

A second paragraph with an inline HTML <kbd> element for styling: Press Ctrl + K to open search (prototype later).

Blockquote: Use blockquotes for notes, citations, or callouts.

A second paragraph inside the same blockquote.


Typography

Headings

H4 Heading

H5 Heading
H6 Heading

Horizontal Rule


Escaping and special characters

Use backslashes to escape: *literal asterisks* and _literal underscores_.

Definition-like content (theme should handle spacing)

Term
Not true definition list markdown; this is just a visual test line.
If you add real definition list support later, you can style it.

Lists

Unordered list

Ordered list

  1. Step one
  2. Step two
    1. Substep 2.1
    2. Substep 2.2
  3. Step three

Task list

Mixed list with code


Code

Inline code: console.log("hello")

Fenced code (JavaScript)

// Example module pattern for docs demos
export function greet(name = "world") {
  const msg = `Hello, ${name}!`;
  console.log(msg);
  return msg;
}

document.addEventListener("DOMContentLoaded", () => {
  greet("GitHub Pages");
});

Fenced code (GML / GameMaker Language)

/// @function scr_spawn_enemy(_type, _x, _y)
/// @desc Spawns an enemy instance and initializes basic state.
/// @param {string} _type
/// @param {real} _x
/// @param {real} _y
function scr_spawn_enemy(_type, _x, _y)
{
    var inst = instance_create_layer(_x, _y, "Instances", obj_enemy);

    inst.enemy_type = _type;
    inst.hp = 10;
    inst.speed = 2.5;

    // Simple state init
    inst.state = "idle";
    inst.target = noone;

    return inst;
}

Fenced code (Bash)

bundle install
bundle exec jekyll serve --livereload

Fenced code (JSON)

{
  "name": "docs-theme-prototype",
  "private": true,
  "scripts": {
    "dev": "bundle exec jekyll serve --livereload"
  }
}

Indented code block

<div class="example">
  Indented code blocks still appear sometimes.
</div>

Diff code block

- old line
+ new line

Tables

Feature Markdown Notes
Left align yes Default for first column
Right align yes Uses ---:
Inline code true Should be monospace
Long text yes Wrap + responsive behavior

A narrower table (test overflow on mobile):

Key Value
A 123
B 456
C 789

Media

Image (relative)

If you add an image at assets/img/sample.png, this should render:

Sample image alt text

Image with title

Alt text with title

Linked image

Clickable image

External image (optional)

If you want to test external sources:

External placeholder


Details & Callouts

Inline HTML callout blocks (useful for theme styling)

Info: This is an info callout using inline HTML. Your theme can style .callout.
Warning: This is a warning callout. Test spacing above/below.
Tip: This is a success callout. Try icons later.

Collapsible section (HTML <details>)

Click to expand details Hidden content. This is useful for long sections. * It can include lists * And **formatting** * And code: ```txt inside details ```

Relative links (test in your repo):

Reference-style links:

This is a reference link and another reference link.


Footnotes

This is a sentence with a footnote.1 And another footnote.2


Math

GitHub Pages won’t render LaTeX by default unless you add MathJax/KaTeX. Still, this helps you verify the raw HTML output and later enhancement.

Inline math: ( E = mc^2 )

Block math:

[ \int_0^\infty e^{-x^2} dx = \frac{\sqrt{\pi}}{2} ]


Embedded content

YouTube embed (responsive test)


File Tree (preformatted)

docs-theme-prototype/
├─ _config.yml
├─ _layouts/
│  └─ default.html
├─ assets/
│  ├─ css/
│  └─ img/
│     └─ sample.png
└─ sample.md

Final notes

End of sample.

  1. Footnote one. Verify styling and spacing. 

  2. Footnote two with bold and inline code