Skip to content

Components

23 pages
  • Asciinema

    In Components

    Components

    asciinema displays a .cast recording in a terminal player. Use it for command-line procedures. Readers can select and copy the terminal text. The six-minute installation recording on this page is about 196 KB. This component plays only terminal …

    asciinema displays a .cast recording in a terminal player. Use it for command-line procedures. Readers can select and copy the terminal text. The six-minute installation recording on this page is about 196 KB. This component plays only terminal …

  • Includes

    In Components

    Components

    include inserts another file’s content into the page. param prints a page or site parameter. comment removes a passage. Use them for fragments or constants shared by multiple pages. For example, use include for installation steps on three pages and …

    include inserts another file’s content into the page. param prints a page or site parameter. comment removes a passage. Use them for fragments or constants shared by multiple pages. For example, use include for installation steps on three pages and …

  • Kbd

    In Components

    Components

    Use keys to show shortcuts and chords separately from prose. Supply one positional parameter per key. The theme draws keycaps, adds separators, and gives screen readers a readable sequence. Use inline code for command names, flags, and text to type. …

    Use keys to show shortcuts and chords separately from prose. Supply one positional parameter per key. The theme draws keycaps, adds separators, and gives screen readers a readable sequence. Use inline code for command names, flags, and text to type. …

  • Badge

    In Components

    Components

    A badge is an inline status label after a name, such as Beta, deprecated, v0.5, or needs a server. Use it for a status of one or two words. Choose a semantic tone. The theme selects colors with contrast in light and dark modes. If the status needs an …

    A badge is an inline status label after a name, such as Beta, deprecated, v0.5, or needs a server. Use it for a status of one or two words. Choose a semantic tone. The theme selects colors with contrast in light and dark modes. If the status needs an …

  • Gallery

    In Components

    Components

    A gallery displays related images in a responsive grid. Put one image per line inside the fence. Use it for multiple views of the same subject, such as screenshots, states, or color schemes. Use an image for a single picture. Gallery images should …

    A gallery displays related images in a responsive grid. Put one image per line inside the fence. Use it for multiple views of the same subject, such as screenshots, states, or color schemes. Use an image for a single picture. Gallery images should …

  • Infographic

    In Components

    Components

    An infographic fence selects an AntV template to display a title and item list. Use it for order, hierarchy, or comparison. Use ECharts for axes and precise numbers. Use Mermaid for flows with conditional branches. The fence contains data and stays …

    An infographic fence selects an AntV template to display a title and item list. Use it for order, hierarchy, or comparison. Use ECharts for axes and precise numbers. Use Mermaid for flows with conditional branches. The fence contains data and stays …

  • ECharts

    In Components

    Components

    An echarts fence contains an ECharts option object in YAML or JSON. It contains data, not code. Use it for quantitative charts with axes, series, and a legend. Use Mermaid for relationships and flows. Use Infographic for order and hierarchy. Hugo …

    An echarts fence contains an ECharts option object in YAML or JSON. It contains data, not code. Use it for quantitative charts with axes, series, and a legend. Use Mermaid for relationships and flows. Use Infographic for order and hierarchy. Hugo …

  • Draw.io

    In Components

    Components

    Draw.io uses plain Markdown images. It has no fence or shortcode. When exporting from Draw.io, select “Include a copy of my diagram”. The SVG or PNG then contains an mxfile copy. The theme detects this copy and adds an edit button. Use this …

    Draw.io uses plain Markdown images. It has no fence or shortcode. When exporting from Draw.io, select “Include a copy of my diagram”. The SVG or PNG then contains an mxfile copy. The theme detects this copy and adds an edit button. Use this …

  • Markmap

    In Components

    Components

    A markmap fence contains a Markdown outline. Headings and lists define the hierarchy. The browser displays an expandable, collapsible tree. Use it to give an overview of a section. For flows with direction or conditions, use Mermaid. Shortest form …

    A markmap fence contains a Markdown outline. Headings and lists define the hierarchy. The browser displays an expandable, collapsible tree. Use it to give an overview of a section. For flows with direction or conditions, use Mermaid. Shortest form …

  • PlantUML

    In Components

    Components

    Write PlantUML source in a plantuml fence. OINK renders it in the reader’s browser with two bundled scripts. No Java, Graphviz executable, npm install, CDN or rendering service is needed. Diagram source stays in the browser when using local …

    Write PlantUML source in a plantuml fence. OINK renders it in the reader’s browser with two bundled scripts. No Java, Graphviz executable, npm install, CDN or rendering service is needed. Diagram source stays in the browser when using local …

  • Component presentation

    In Components

    Components

    Use the Appearance menu to compare Paper, Slate, Ink, and Terminal in light or dark mode. These examples use the same content and preserve the normal Markdown authoring model. Available in OINK 1.4.0 The optional variants on this page ship in OINK …

    Use the Appearance menu to compare Paper, Slate, Ink, and Terminal in light or dark mode. These examples use the same content and preserve the normal Markdown authoring model. Available in OINK 1.4.0 The optional variants on this page ship in OINK …

  • Mermaid

    In Components

    Components

    A mermaid fence displays text as a flowchart, sequence diagram, Gantt chart, class diagram, ER diagram, or state diagram. Git stores the diagram source, diffs show changes, and search can find it. The reader’s browser renders it with bundled Mermaid. …

    A mermaid fence displays text as a flowchart, sequence diagram, Gantt chart, class diagram, ER diagram, or state diagram. Git stores the diagram source, diffs show changes, and search can find it. The reader’s browser renders it with bundled Mermaid. …

  • Math

    In Components

    Components

    KaTeX renders mathematics to HTML + MathML at build time. Pages with formulas load one local KaTeX stylesheet. They load no JavaScript and contact no remote mathematics service. Use \(…\) for inline formulas, $$…$$ or \[…\] for display formulas, or …

    KaTeX renders mathematics to HTML + MathML at build time. Pages with formulas load one local KaTeX stylesheet. They load no JavaScript and contact no remote mathematics service. Use \(…\) for inline formulas, $$…$$ or \[…\] for display formulas, or …

  • FileTree

    In Components

    Components

    A filetree fence contains a directory listing. Indentation sets depth, a trailing / marks a directory, and text after # is a comment. Use it to explain the relevant directory structure, with one annotation per entry. If readers need to copy the exact …

    A filetree fence contains a directory listing. Indentation sets depth, a trailing / marks a directory, and text after # is a comment. Use it to explain the relevant directory structure, with one annotation per entry. If readers need to copy the exact …

  • Cards

    In Components

    Components

    Cards provide related links. Each card has a linked title and a sentence. The grid adapts to the container width. Use cards for section landing pages, reading recommendations, or a few related entry points. Use paragraphs for prose and a gallery for …

    Cards provide related links. Each card has a linked title and a sentence. The grid adapts to the container width. Use cards for section landing pages, reading recommendations, or a few related entry points. Use paragraphs for prose and a gallery for …

  • Steps

    In Components

    Components

    Steps display an ordered list with numbered dots and a connecting line. Add a {.steps} marker line to an ordered list. CSS draws the dots and line. No script loads. Use steps for ordered procedures. Use plain lists or cards for unordered items. There …

    Steps display an ordered list with numbered dots and a connecting line. Add a {.steps} marker line to an ordered list. CSS draws the dots and line. No script loads. Use steps for ordered procedures. Use plain lists or cards for unordered items. There …

  • Fields

    In Components

    Components

    Fields display named values, metadata, and descriptions as a responsive definition list. Each name has its own line. Small chips beside it show type, required status, and default value. The description starts on the next line. Each entry has an …

    Fields display named values, metadata, and descriptions as a responsive definition list. Each name has its own line. Small chips beside it show type, required status, and default value. The description starts on the next line. Each entry has an …

  • Tables

    In Components

    Components

    Tables use ordinary GFM pipe syntax. The table render hook wraps each table in a horizontally scrollable region. The {…} attribute line below selects captions, compatibility matrices, field lists, numbering, or tabs. Merged cells, sorting, and …

    Tables use ordinary GFM pipe syntax. The table render hook wraps each table in a horizontally scrollable region. The {…} attribute line below selects captions, compatibility matrices, field lists, numbering, or tabs. Merged cells, sorting, and …

  • Tabs

    In Components

    Components

    Use tabs for equivalent alternatives, such as package managers, distributions, YAML / TOML / JSON, or environment variables and configuration keys. Do not use tabs for ordered steps or unrelated content. Readers see only one panel at a time. The …

    Use tabs for equivalent alternatives, such as package managers, distributions, YAML / TOML / JSON, or environment variables and configuration keys. Do not use tabs for ordered steps or unrelated content. Readers see only one panel at a time. The …

  • Components

    In Components

    Components

    Use this section to write components in Markdown. Each page starts with the shortest example, then gives more detailed examples. The page also gives the output matrix, parameter table, and limits. Use the cheatsheet below for a quick syntax …

    Use this section to write components in Markdown. Each page starts with the shortest example, then gives more detailed examples. The page also gives the output matrix, parameter table, and limits. Use the cheatsheet below for a quick syntax …

  • Code Blocks

    In Components

    Components

    A code block uses an ordinary Markdown fence. Hugo’s embedded Chroma highlighter runs at build time. The browser has no highlighter. Use code blocks for commands, configuration snippets, and source code. The {…} attributes on the fence’s info line …

    A code block uses an ordinary Markdown fence. Hugo’s embedded Chroma highlighter runs at build time. The browser has no highlighter. Use code blocks for commands, configuration snippets, and source code. The {…} attributes on the fence’s info line …

  • Images

    In Components

    Components

    Write images with Markdown’s ![alt text](source "title") syntax. For an image in its own paragraph, add a {…} attribute line to enable captions, zoom, numbering, or Hugo processing. The theme has no image shortcode. Shortest form Source ![The OINK …

    Write images with Markdown’s ![alt text](source "title") syntax. For an image in its own paragraph, add a {…} attribute line to enable captions, zoom, numbering, or Hugo processing. The theme has no image shortcode. Shortest form Source ![The OINK …

  • Callouts

    In Components

    Components

    A callout is a GitHub / Obsidian style blockquote. Put > [!TYPE] on the first line and the body below it. Use callouts to separate prerequisites, warnings, and asides from prose. If a prose sentence is sufficient, a callout is unnecessary. Shortest …

    A callout is a GitHub / Obsidian style blockquote. Put > [!TYPE] on the first line and the body below it. Use callouts to separate prerequisites, warnings, and asides from prose. If a prose sentence is sufficient, a callout is unnecessary. Shortest …