Skip to content

Welcome to the Poly Hammer Docs

For full documentation visit mkdocs.org.

This page is designed to test all the colors used in the Poly Hammer Docs theme.

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Project layout 1

    mkdocs.yml    # The configuration file.
    extra:
    social:
        -  icon: fontawesome/brands/mastodon 
           link: https://fosstodon.org/@squidfunk

Headings

Heading 3

Heading 4

Heading 5
Heading 6

Text

  • Bold Text
  • Italic Text
  • Strikethrough Text
  • Inline Code

Admonitions

Note

This is a note.

Tip

This is a tip.

Info

This is some information.

Warning

This is a warning.

Danger

This is a danger alert.

Caution

This is a caution alert.

Success

This is a success message.

Failure

This is a failure message.

Bug

This is a bug alert.

Example

This is an example.

Quote

This is a quote.

Lists

Unordered List

  • Item 1
  • Item 2
  • Subitem 2.1
  • Subitem 2.2

Ordered List

  1. First item
  2. Second item
  3. Subitem 2.1
  4. Subitem 2.2

Blockquotes

This is a blockquote.

Code Blocks

def hello_world():
    print("Hello, World!")

Tables

Header 1 Header 2 Header 3
Row 1 Data Data
Row 2 Data Data

Footnote

Here's a sentence with a footnote. 1

Subscript & Superscript

H2O

X2

Use these Docs for info on how to format content

this is italic and so is this this is bold and so is this underline, strike through highlight and inline code you can combine too

Test Image

Task List

  • item 1
    • item A
    • item B more text
      • item a
      • item b
      • item c
    • item C
  • item 2
  • item 3
a fenced block

  • a fenced block

Definition : 

a fenced block

  1. This is the footnote. ↩