Skip to main content

Markdown and GFM

This page exercises standard Markdown, GFM, and Docusaurus docs conventions.

Table of contents depth

Inline code heading provider-id

This heading verifies that table-of-contents code uses the canonical inline code surface.

Jump to paragraph flow, lists, tables, or details.

Hero art

Figure fixture

Figure surfaces should own their image and caption spacing.

Paragraph flow and emphasis

This first paragraph establishes the default prose flow rhythm with an inline link and inline code.

This consecutive paragraph checks paragraph-to-paragraph spacing with strong text, emphasized text, and deleted text in the same run.

A hard line break ends here.
This sentence starts after the rendered break.

An automatic link renders from https://docusaurus.io/docs/markdown-features while escaped characters remain literal: *not emphasized*.

A footnote reference keeps supporting detail out of the main reading flow.1

Heading ladder

Fourth level heading

Paragraph after h4 keeps the official h + * spacing contract.

Fifth level heading

Paragraph after h5 keeps muted heading styling while preserving normal body flow.

Sixth level heading

Paragraph after h6 keeps uppercase treatment and the same paragraph rhythm.

Lists and tasks

  • Top-level unordered item
    • Second-level unordered item
      • Third-level unordered item with nested code
  • Another unordered item with bold and italic
  1. Ordered list item
  2. Nested content
    • Bullet item

    • Another bullet with a follow-up paragraph.

      Nested paragraph under a list item keeps the half-em offset.

  • Theme package linked from workspace
  • Algolia config intentionally omitted
  • Publish workflow out of scope for this starter task

Tables

SurfaceExampleNotes
Inline codepnpm dlxRenders with theme code styling
Block codefenced snippetsPreserves syntax colors
Quote> blockquoteInherits token-driven borders

Code

Inline code looks like const ready = true.

src/components/hello.tsx
export function Hello() {
return <span>Hello docs theme</span>;
}
build.sh
yarn workspace @aeei/docs-starter build
highlighted-lines.ts
const stable = true;
const highlighted = "This line is highlighted";
const complete = stable && highlighted.length > 0;

Quotes and rules

Blockquotes should remain readable across light and dark modes.

Second quoted paragraph keeps the first-child reset inside blockquote.


Post-rule heading

Paragraph after the horizontal rule heading keeps the official flow margin instead of the generic h + * reset.

Details and admonitions

Token note

Expandable disclosure

Wrapping edge cases

A deliberately long URL must wrap without resizing the page: https://example.com/documentation/components/base-nova/responsive-layout/this-path-is-intentionally-long-enough-to-exercise-mobile-line-wrapping-without-horizontal-page-overflow.

this_inline_code_token_is_intentionally_long_enough_to_require_local_scrolling_or_wrapping_without_expanding_the_document_shell

Footnotes

  1. Footnotes use the same body typography, link treatment, and spacing tokens as the surrounding document.