Welcome to MkDocs
For full documentation visit mkdocs.org.
https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN
Macarons are delicious but tricky to make.
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!
This is a Warning:
Description text hereThis is a Note:
Description text hereThis is a Hint:
Description text hereCheck:
Description text hereAdditional 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
:::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
azerty
```javascript I'm A tab console.log('Code Tab A');
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.
Definition :
Fonction Python pour vérifier si un nombre est premier
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
- item 1
- item A
- item B
more text
- item a
- item b
- item c
- item C
- item 2
- item 3
Method | Description |
---|---|
GET |
Fetch resource |
PUT |
Update resource |
DELETE |
Delete resource |
- 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
withpip
and get up and running in minutes -
It's just Markdown
Focus on your content and generate a responsive and searchable static site
-
Made to measure
Change the colors, fonts, language, icons, logo and more with a few lines
-
Open Source, MIT
Material for MkDocs is licensed under MIT and available on [GitHub]