Aller au contenu
ZenithDocs
Français

Markdown

Standard Markdown, GitHub Flavored Markdown and a few extensions.

Sur cette page

Pages are written in Markdown or MDX. ZenithDocs supports GitHub Flavored Markdown out of the box: tables, task lists, strikethrough, autolinks and footnotes.

Text formatting

You can use bold, italic, strikethrough, inline code and links. Keyboard keys use the HTML element: press Ctrl + K.

Blockquotes are useful to quote other sources.

  • Unordered lists
    • can be nested
  • and turned into task lists
  • like this one
  1. Ordered lists
  2. work too

Callouts

Use a container directive to highlight important information. The label between brackets replaces the default title.

GitHub alerts, the blockquote syntax GitHub uses for callouts, work too. Files render the same on GitHub and on your site:

The six types are note, tip, important, success, warning and danger. Aliases keep their own title: info is a note, idea a tip, check a success, warn a warning, and caution and error are dangers.

Headings

Headings from level 2 to 3 are listed in the table of contents, and each one gets an anchor link. Set a custom id by ending the heading with [#your-id].

A heading with a custom id

This heading can be linked to with #custom-id.

Footnotes

Footnotes are collected at the end of the page.1

Footnotes

  1. Like this one. ↩

Dernière mise à jour le