Welcome to MkDocs

For full documentation visit mkdocs.org.

ddghytrryjgfg hgfujhfh ![](https://mdg.imgix.net/assets/images/san-juan-mountains.jpg )

Image title

https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN

Macarons are delicious but tricky to make.

const greeting = "I will get JavaScript syntax highlighting";

<p>
I will not be linted.
</p>

Note: This is how you write a note.

It can have multiple lines.

Note: This is how you write a note.

It can have multiple lines.

Warning: This is how you write a warning.

It can have multiple paragraphs. This will produce the following HTML:

The quarterly results look great

Sales were off the chart!

Morale is strong!

Poised to go public next spring!

Everything is going according to the plan.

HelloWorld.java:

```java class HelloWorld { public static void main(String[] args) { System.out.println("Simple hello world program"); } }

[!NOTE]
Highlights information that users should take into account, even when skimming.

[!IMPORTANT]
Crucial information necessary for users to succeed.

[!WARNING]
Critical content demanding immediate user attention due to potential risks.

Note This is a note

Warning This is a warning

You can use tables or quotes (tested on Gitlab and Github only):

Using table | ⚠️ Warning | |------------------------------------------| | You shouldn't. This is irreversible! |

❌ Error
Don't do that. This is irreversible!

ℹ️ Information
You can do that without problem.

✅ Success
Don't hesitate to do that.

🦄 New line support
It supports new lines: .. simply use `

⚠️ Warning

You shouldn't. This is irreversible!

❌ Error

Don't do that. This is irreversible!

ℹ️ Information

You can do that without problem.

✅ Success

Don't hesitate to do that.

🦄 New line support

It supports new lines:

.. simply use an empty > line

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.

GitLab Orange Heading

/// note | Some title attrs: {class: class-name: id: id-name}

Some content ///

html | div {: width="50%" height="50%" border="2" } some markdown content

Have fun!

It works!

Tip: Use blue boxes for Tips and notes. If it's a note, you don't have to include the word "Note".

Example: Use yellow boxes for examples that are not inside code cells, or use for mathematical formulas if needed.

Up to you: Use green boxes sparingly, and only for some specific purpose that the other boxes can't cover. For example, if you have a lot of related content to link to, maybe you decide to use green boxes for related links from each section of a notebook.

Just don't: In general, just avoid the red boxes.

This is a Warning:
Description text here

This is a Note:
Description text here

This is a Hint:
Description text here

Check:
Description text here

Additional Information:
Description text here

⚠️ This is a Warning: Description text here

📝 This is a Note: Description text here

💡 This is a Hint: Description text here

✅ Check: Description text here

🏆 Check: Description text here

⛔️ Error: Description text here

❌ Error: Description text here

❗ Attention: Description text here

🚧 Attention: Description text here

Some very long text here. The text must span multiple lines in order to demonstrate that this works. bobbyhadz.com

:::row::: :::column span="2"::: This is a 2-span column with lots of text.

  Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec vestibulum mollis nunc
  ornare commodo. Nullam ac metus imperdiet, rutrum justo vel, vulputate leo. Donec
  rutrum non eros eget consectetur.

:::column-end::: :::column span=""::: This is a single-span column with an image in it.

  ![Doc.U.Ment](media/markdown-reference/document.png)

:::column-end::: :::row-end:::

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

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5

Heading 6

This is normal, continuous text.
This is the first line of the code block.
The second line is further indented.
This is another line of code block.This is where continuous text begins again.

azerty

A code block with inline styles. Fancy!

azerty

```javascript I'm A tab console.log('Code Tab A');

```javascript I'm tab B
console.log('Code Tab B');

def bubble_sort(items):
    for i in range(len(items)):
        for j in range(len(items) - 1 - i):
            if items[j] > items[j + 1]:
                items[j], items[j + 1] = items[j + 1], items[j]

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.

Phasellus posuere in sem ut cursus

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.

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.

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.

Success

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.

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.

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.

Failure

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.

Danger

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.

a fenced block

with blank lines

```
a fenced block
```

Definition :

a fenced block

Fonction Python pour vérifier si un nombre est premier

def is_prime(n) :
 for i in range(2,n) :
 if (n%i) == 0 :
 return False
 return True

"""Some file."""
import foo.bar
import boo.baz
import foo.bar.baz

import foo
import boo.baz
import foo.bar.baz

class Foo:
   def __init__(self):
       self.foo = None
       self.bar = None
       self.baz = None

mark me

smart == mark

Task List

Subscribe to our newsletter

Send

Method	Description
`GET`	Fetch resource
`PUT`	Update resource
`DELETE`	Delete resource

Image title

HTML for content and structure
JavaScript for interactivity
CSS for text running out of boxes
Internet Explorer ... huh?

Set up in 5 minutes

Install mkdocs-material with pip and get up and running in minutes

Getting started
It's just Markdown

Focus on your content and generate a responsive and searchable static site

Reference
Made to measure

Change the colors, fonts, language, icons, logo and more with a few lines

Customization
Open Source, MIT

Material for MkDocs is licensed under MIT and available on [GitHub]

License