Skip to content

Welcome to the MDLZ's Documentation Template

Hello and welcome! This site is a template built using MKDocs, an awesome static site generator that's geared towards project documentation. But don't worry, even if you're new to MKDocs, we're here to guide you through it.

What is MKDocs?

MKDocs is a fast, simple, and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

What is MKDocs Material?

For the look and feel of our site, we're utilizing the MKDocs Material theme. MKDocs Material is a material design theme for MKDocs. It is built using Google's Material Design guidelines, making your documentation look incredibly professional and easy-to-navigate.

Getting Started with Markdown

Markdown Basics

Markdown is a lightweight markup language that's easy to learn. Let's start with the basics:

  1. Headers: Use '#' for H1 headers, '##' for H2, and so on up to '######' for H6.
# This is an H1 header

## This is an H2 header

### This is an H3 header

  1. Paragraphs: Paragraphs in Markdown are just one or more lines of consecutive text followed by one or more blank lines.

  2. Emphasis: Use '*' or '_' to emphasize text. One for italics, two for bold.

_This is italicized_
**This is bold**
**_This is bold and italicized_**
  1. Lists: Use '*' or '-' for bullet points. For numbered lists, simply start a line with a number.
- Item 1
- Item 2

1. First item
2. Second item
  1. Links: To create a hyperlink, use '[]' for the link text and '()' for the URL.
[Mondelēz International.](https://www.mondelezinternational.com/)
  1. Images: Images are similar to links, but they start with a '!'.
![Mondelēz International Logo](https://www.mondelezinternational.com/-/media/Mondelez/Images/logo.png)
  1. Code: To denote a word or phrase as code, enclose it in backticks (`). For blocks of code, you can use triple backticks and optionally indicate the programming language.
`code`

```python
def hello_world():
    print("Hello, world!")
```

Extending Markdown with MKDocs and MKDocs Material

MKDocs and the MKDocs Material theme extend Markdown's capabilities, offering additional features like footnotes, tables of contents, abbreviations, and more.

  1. Footnotes: You can easily add footnotes using the following syntax.
Here's a statement that requires a footnote.[^1]

[^1]: This is the footnote.

  1. Table of Contents (TOC): MKDocs Material automatically generates a table of contents from your headers.

  2. Abbreviations: Define abbreviations that get expanded on hover.

*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium
  1. Admonitions (Notes, Warnings, etc.): MKDocs Material supports admonitions, providing you with the means to highlight information.
!!! note
This is a note.

!!! warning
This is a warning.
  1. Code Blocks with Syntax Highlighting: MKDocs Material uses Pygments for syntax highlighting in code blocks. Simply specify the language after the initial backticks.
```python
def hello_world():
    print("Hello, world!")
```
  1. Tables: You can create tables in Markdown by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe |.
| First Header | Second Header |
| ------------ | ------------- |
| Content Cell | Content Cell  |
| Content Cell | Content Cell  |

Remember, this is just a primer on what you can do with Markdown and MKDocs. You can always refer to the official MKDocs documentation and the official MKDocs Material documentation for more detailed information.

Enjoy building your documentation site with our MkDocs template!