GitHub

Übersetzung nicht verfügbar

Diese Seite wurde noch nicht übersetzt, daher wird die Standardsprache angezeigt.

Markdown#

Kiln renders markdown with swift-markdown (CommonMark + GitHub-flavoured extensions). This page is also a live demo — everything shown here is rendered by Kiln.

Headings & table of contents#

Every heading gets a GitHub-style slug id and a permalink anchor, and Kiln builds an on-page table of contents from them automatically.

Code blocks#

Fenced code blocks are highlighted client-side with highlight.js:

struct Greeter {
    let name: String
    func greet() -> String { "Hello, \(name)!" }
}

Inline code works too.

Tables#

Syntax Renders as
**bold** bold
*italic* italic
`code` code

Lists#

  • Unordered item

  • Another item

    • Nested item

  1. Ordered item

  2. Second item

  • A completed task

  • An open task

Admonitions#

MkDocs/Python-Markdown-style call-outs:

Optional title

Body content, rendered as markdown.

Collapsible

Hidden until expanded (use ???+ to start expanded).


Rendered:

Optional title

Body content, rendered as markdown.

Collapsible

Hidden until expanded (use ???+ to start expanded).

Supported types include note, tip, warning, danger, info, and success.

Front matter#

An optional YAML block at the top of a file (the meta extension) overrides per-page metadata:

---
title: Custom Page Title
description: Used for meta and social tags.
image: assets/custom-card.png   # per-page social preview image
template: landing               # override the Leaf template for this page
---
Key Effect
title Overrides the <title> and heading-derived page title.
description Sets the meta/OpenGraph description for the page.
image Per-page social preview image (see SEO & Social Cards).
template Renders the page with a different Leaf template.

Note

This very page sets no front matter, but Configuration sets a custom title — compare their browser tabs.

Standard markdown links and images work, and intra-doc links between .md files are rewritten to the correct pretty, locale-aware URLs at build time — see Link Checking. Relative image paths are resolved against the page’s location and copied into the output.

Diese Seite bearbeiten