Markdown Baseline

Common GitHub-flavored Markdown behavior is enabled by default. You do not need any configuration for the features on this page — every rendered example below is produced by this documentation site itself with the default settings.

Turn any of them off explicitly when a site needs stricter CommonMark behavior:

import { oxContent } from "@ox-content/vite-plugin";

export default {
  plugins: [
    oxContent({
      strikethrough: false,
      taskLists: false,
    }),
  ],
};

Tables

| Feature    | Status  |
| ---------- | ------- |
| Tables     | Default |
| Task lists | Default |

Rendered:

Task Lists

- [x] Parse Markdown in Rust
- [x] Render HTML
- [ ] Take over the world

Rendered:

• Parse Markdown in Rust
• Render HTML
• Take over the world

Strikethrough

Ox Content is ~~slow~~ fast.

Rendered:

Ox Content is slow fast.

Autolinks

Bare URLs become links. The default follows gfm, so autolinks: false opts out without giving up the rest of GFM.

Docs live at https://ubugeeei-prod.github.io/ox-content/

Rendered:

Docs live at https://ubugeeei-prod.github.io/ox-content/

Auto-linked URLs open in a new tab with rel="noopener noreferrer".

Footnotes

Ox Content renders footnotes natively.[^1]

[^1]: This is the footnote body.

Rendered:

Ox Content renders footnotes natively.¹

The reference becomes a superscript link, and the definition renders where it is written in the source with a back-link — put definitions at the bottom of a page to collect them there.

Frontmatter

YAML frontmatter is parsed before rendering and never appears in the output HTML. This page starts with:

---
title: Markdown Baseline
description: GitHub-flavored Markdown, frontmatter, and table-of-contents defaults that are on out of the box.
---

The SSG theme uses title for the document title and navigation, and description for <meta name="description"> and Open Graph tags. Any other keys are passed through: .md modules expose them as the frontmatter export, collections expose them to queries, and custom transformers receive them as context.frontmatter.

import { frontmatter, html } from "./guide.md";

console.log(frontmatter.title); // "Markdown Baseline"

Table of Contents

A TOC is built from headings during transform. The sidebar navigation for this very page is driven by it. tocMaxDepth: 3 means # through ### are included by default; deeper headings are rendered but not indexed.

oxContent({
  toc: true,
  tocMaxDepth: 3,
});

The TOC is exposed to .md modules as a tree of { depth, text, slug, children } entries:

[
  {
    "depth": 1,
    "text": "Install Guide",
    "slug": "install-guide",
    "children": [
      { "depth": 2, "text": "Prerequisites", "slug": "prerequisites", "children": [] },
      { "depth": 2, "text": "Run Vite", "slug": "run-vite", "children": [] }
    ]
  }
]

Every heading also gets a stable id attribute (the slug above), so deep links like #task-lists work on every page.

Related

• Syntax Extensions — opt-in authoring syntax on top of this baseline.
• Built-in Features overview