Writing docs

The theme styles all the common Markdown constructs. This page demonstrates how each one renders.

Headings

Use # through #### to outline a page. Heading anchors appear on hover so readers can copy direct links.

Lists

Unordered:

  • First item
  • Second item
  • Third item with a link

Ordered:

  1. Run the install command.
  2. Configure your mkdocs.yml.
  3. Run mkdocs serve.

Task list:

  • Install MkDocs
  • Install the Respect theme
  • Write your first page

Nested:

  • Components
    • Validation
    • Assertion
    • Stringifier
  • Tools
    • StringFormatter

Blockquotes

Independent, easy to use software components.

Inline elements

You can mark inline code, bold, italic, and ~~strikethrough~~ text. Keyboard shortcuts use <kbd> like + K to open search.

Horizontal rules


Use --- to break a long page into clear sections.