Skip to content

Markdown - Mkdocs

Mkdocs

For full documentation visit mkdocs.org

  • 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.

Extensions I Am Using

Admonition

Inline Left

Should be on far left

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

Inline Right

Should be on far right

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

Example Title - SQL Included As Further Example

Example Text

SELECT TABLE_NAME, COLUMN_NAME, DATA_TYPE, CHARACTER_MAXIMUM_LENGTH, IS_NULLABLE 
FROM INFORMATION_SCHEMA.COLUMNS
End Example Text


Supported Admonition Types

The Material theme supports a wide range of types, each with its own icon and color
Other keywords work, but check the admonitions.md file for the proper names.

Quote

Example

Bug

Example

Danger

Example

Failure

Example

Warning

Example

Question

Example

Success

Example

Abstract

Example

Note

Example

Info

Example

Tip

Example

Example

Example