Skip to content

Content tabs

Content Tabs

This is some examples of content tabs.

Material for MkDocs is the ultimate framework for creating stunning, interactive documentation sites. In this tutorial, we’ll be creating a new documentation portal completely from scratch, and then hosting that on the web for free using GitHub pages.

Along the way, you'll learn just a handful of the awesome features that Material for MkDocs comes bundled with, such as:

  • Setting a dynamic colour scheme
  • Adding a splash of personality with emojis, icons and logos to make your content visually appealing
  • How to create custom code blocks that adjust based on the programming language specified
  • How to better organise your documentation using content tabs
  • How to empathize parts of your content using admonitions - also known as callouts
  • And how to bring your ideas to life with statically rendered diagrams directly in your docs
Tip

This is an in-depth tutorial. If this is your first time using Material for MkDocs then you're probably best to just follow it all through from the beginning.

Generic Content

This is some plain text

  • First item
  • Second item
  • Third item
  1. First item
  2. Second item
  3. Third item

Code Blocks in Content Tabs

def main():
    print("Hello world!")

if __name__ == "__main__":
    main()

There are some explanation about the codes above.

function main() {
    console.log("Hello world!");
}

main();

Admonitions (aka Callouts)

Note

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.

Warning

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.

Tip

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.

Question

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.

Collapsible callout:

Collapsible callout

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.

more examples of admonitions check official references.

equations:

\[ \cos x=\sum_{k=0}^{\infty}\frac{(-1)^k}{(2k)!}x^{2k} \]

Comments