04-03-2022
This commit is contained in:
482
docs/MkDocs/index.md
Normal file
482
docs/MkDocs/index.md
Normal file
@@ -0,0 +1,482 @@
|
||||
# Welcome to MkDocs
|
||||
|
||||
For full documentation visit [mkdocs.org](http://mkdocs.org).
|
||||
|
||||
|
||||
|
||||
### Installation:
|
||||
|
||||
```bash
|
||||
$ pip install mkdocs
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Commandes:
|
||||
|
||||
* `mkdocs new [dir-name]` - Create a new project.
|
||||
* `mkdocs serve` - Start the live-reloading docs server.
|
||||
* `mkdocs build` - Build the documentation site.
|
||||
* `mkdocs help` - Print this help message.
|
||||
* `gh-deploy` - Deploy your documentation to GitHub Pages.
|
||||
|
||||
|
||||
|
||||
### Project layout:
|
||||
|
||||
```bash
|
||||
mkdocs.yml # The configuration file.
|
||||
docs/
|
||||
index.md # The documentation homepage.
|
||||
... # Other markdown pages, images and other files.
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Créer un nouveau projet de docs:
|
||||
|
||||
```bash
|
||||
bruno@SilverBook:~$ mkdocs new project
|
||||
|
||||
INFO - Creating project directory: project
|
||||
|
||||
INFO - Writing config file: project/mkdocs.yml
|
||||
|
||||
INFO - Writing initial docs: project/docs/index.md
|
||||
|
||||
bruno@SilverBook:~$ cd project
|
||||
|
||||
total 8
|
||||
drwxr-xr-x 4 bruno staff 128 16 déc 20:48 .
|
||||
drwxr-xr-x@ 70 bruno staff 2240 16 déc 20:48 ..
|
||||
drwxr-xr-x 3 bruno staff 96 16 déc 20:48 docs
|
||||
-rw-r--r-- 1 bruno staff 19 16 déc 20:48 mkdocs.yml
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Servir le projet:
|
||||
|
||||
```bash
|
||||
bruno@SilverBook:~/project$ mkdocs serve
|
||||
|
||||
INFO - Building documentation...
|
||||
|
||||
INFO - Cleaning site directory
|
||||
|
||||
[I 171216 20:54:40 server:283] Serving on http://127.0.0.1:8000
|
||||
[I 171216 20:54:40 handlers:60] Start watching changes
|
||||
[I 171216 20:54:40 handlers:62] Start detecting changes
|
||||
[I 171216 20:55:00 handlers:133] Browser Connected: http://127.0.0.1:8000/
|
||||
[I 171216 20:55:41 handlers:133] Browser Connected: http://127.0.0.1:8000/
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Copier les docs sur le serveur:
|
||||
|
||||
```bash
|
||||
$ cd /Users/bruno/project
|
||||
|
||||
$ ./build_and_upload.sh
|
||||
```
|
||||
|
||||
|
||||
|
||||
/build_and_upload.sh
|
||||
|
||||
```bash
|
||||
# !/bin/bash
|
||||
|
||||
cd /Users/bruno/project
|
||||
mkdocs build
|
||||
scp -P42666 -r ./central_docs bruno@192.168.xxx.xxx:/volume1/web
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Admonitions:
|
||||
|
||||
#### Note:
|
||||
|
||||
**Note simple:**
|
||||
|
||||
```markdown
|
||||
!!! 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.
|
||||
|
||||
**Note avec titre:**
|
||||
|
||||
```markdown
|
||||
!!! note "Phasellus posuere in sem ut cursus"
|
||||
```
|
||||
|
||||
!!! note "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 sans titre:**
|
||||
|
||||
```markdown
|
||||
!!! note ""
|
||||
```
|
||||
|
||||
!!! 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 avec contenu:**
|
||||
|
||||
!!! 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. ``` python 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] ``` Nunc eu odio eleifend, blandit leo a, volutpat sapien. Phasellus posuere in sem ut cursus. Nullam sit amet tincidunt ipsum, sit amet elementum turpis. Etiam ipsum quam, mattis in purus vitae, lacinia fermentum enim.
|
||||
|
||||
**Note collapsible ouverte:**
|
||||
|
||||
```markdown
|
||||
??? 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.
|
||||
|
||||
**Note collapsible fermée:**
|
||||
|
||||
```markdown
|
||||
???+ 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.
|
||||
|
||||
#### Type:
|
||||
|
||||
`abstract`, `summary`, `tldr`
|
||||
|
||||
```markdown
|
||||
!!! abstract "Résumé"
|
||||
```
|
||||
|
||||
!!! abstract "Résumé"
|
||||
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.
|
||||
|
||||
`info`, `todo`
|
||||
|
||||
```
|
||||
!!! info "Info"
|
||||
```
|
||||
|
||||
!!! info "Info"
|
||||
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`, `hint`, `important`
|
||||
|
||||
```markdown
|
||||
!!! tip "Tip"
|
||||
```
|
||||
|
||||
!!! tip "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.
|
||||
|
||||
`success`, `check`, `done`
|
||||
|
||||
```markdown
|
||||
!!! success "Succès"
|
||||
```
|
||||
|
||||
!!! success "Succès"
|
||||
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`, `help`, `faq`
|
||||
|
||||
```markdown
|
||||
!!! help "Aide"
|
||||
```
|
||||
|
||||
!!! help "Aide"
|
||||
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`, `caution`, `attention`
|
||||
|
||||
```markdown
|
||||
!!! warning "Attention"
|
||||
```
|
||||
|
||||
!!! warning "Attention"
|
||||
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`, `fail`, `missing`
|
||||
|
||||
```markdown
|
||||
!!! fail "Echec"
|
||||
```
|
||||
|
||||
!!! fail "Echec"
|
||||
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`, `error`
|
||||
|
||||
```markdown
|
||||
!!! danger "Erreur"
|
||||
```
|
||||
|
||||
!!! danger "Erreur"
|
||||
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.
|
||||
|
||||
|
||||
|
||||
`bug`
|
||||
|
||||
```markdown
|
||||
!!! bug "Bug"
|
||||
```
|
||||
|
||||
!!! bug "Bug"
|
||||
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`
|
||||
|
||||
```markdown
|
||||
!!! example "Exemple"
|
||||
```
|
||||
|
||||
!!! example "Exemple"
|
||||
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.
|
||||
|
||||
|
||||
|
||||
`quote`, `cite`
|
||||
|
||||
```markdown
|
||||
!!! quote "Citation"
|
||||
```
|
||||
|
||||
!!! quote "Citation"
|
||||
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.
|
||||
|
||||
|
||||
|
||||
https://squidfunk.github.io/mkdocs-material/reference/abbreviations/
|
||||
|
||||
|
||||
|
||||
### Font Awesome icons:
|
||||
|
||||
:fa-link: [http://bwmarrin.github.io/MkDocsPlus/](http://bwmarrin.github.io/MkDocsPlus/)
|
||||
|
||||
[:fa-link: http://fontawesome.io/icons/](http://fontawesome.io/icons/)
|
||||
|
||||
|
||||
|
||||
```html
|
||||
:fa-link:
|
||||
```
|
||||
|
||||
:fa-link:
|
||||
|
||||
|
||||
```html
|
||||
<i class="fa fa-link fa-lg"></i>
|
||||
```
|
||||
|
||||
<i class="fa fa-link fa-lg"></i>
|
||||
|
||||
|
||||
|
||||
```html
|
||||
<i class="fa fa-link fa-2x"></i>
|
||||
```
|
||||
|
||||
<i class="fa fa-link fa-2x"></i>
|
||||
|
||||
|
||||
|
||||
```html
|
||||
<i class="fa fa-link fa-5x"></i>
|
||||
```
|
||||
|
||||
<i class="fa fa-link fa-5x"></i>
|
||||
|
||||
|
||||
|
||||
### Themes:
|
||||
|
||||
#### Installer un thème:
|
||||
|
||||
```bash
|
||||
$ pip install mkdocs-cinder
|
||||
```
|
||||
|
||||
|
||||
|
||||
#### Mettre à jour un thème:
|
||||
|
||||
```bash
|
||||
$ pip install --upgrade mkdocs-material
|
||||
```
|
||||
|
||||
|
||||
|
||||
[:octicons-link: MkDocs-Themes](https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes)
|
||||
|
||||
[:octicons-link: Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
|
||||
|
||||
[:octicons-link: MkDocs+](http://bwmarrin.github.io/MkDocsPlus/)
|
||||
|
||||
https://github.com/otsuarez/mkdocs_auth
|
||||
|
||||
|
||||
|
||||
### Plugins:
|
||||
|
||||
- mkdocs-material-extensions
|
||||
- mkdocs-git-revision-date-localized-plugin
|
||||
- mkdocs-minify-plugin
|
||||
- fontawesome_markdown
|
||||
- mkdocs-pdf-export-plugin
|
||||
- markdown
|
||||
- pymdown-extensions
|
||||
|
||||
```bash
|
||||
$ pip install --upgrade mkdocs-material-extensions mkdocs-git-revision-date-localized-plugin mkdocs-minify-plugin fontawesome_markdown mkdocs-pdf-export-plugin markdown pymdown-extensions
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Structures:
|
||||
|
||||
```bash linenums="1" hl_lines="1 19 30 44 45 47 51 67 69"
|
||||
├── central_docs (*)
|
||||
│ ├── Distributions
|
||||
│ │ ├── Mint
|
||||
├── docs
|
||||
│ ├── Distributions
|
||||
│ │ ├── Mint
|
||||
│ │ ├── Mint.md
|
||||
│ │ ├── applications.md
|
||||
│ │ ├── backup.md
|
||||
│ │ ├── grub.md
|
||||
│ │ ├── index.md
|
||||
│ │ ├── samba.md
|
||||
│ │ ├── systemctl.md
|
||||
│ │ ├── vsftpd.md
|
||||
│ │ └── webserver.md
|
||||
│ ├── NBResources
|
||||
│ │ └── Misc
|
||||
│ │ └── RecentItems.txt
|
||||
│ ├── assets (*)
|
||||
│ │ └── icons
|
||||
│ │ ├── icon-128x128.png
|
||||
│ │ ├── icon-144x144.png
|
||||
│ │ ├── icon-152x152.png
|
||||
│ │ ├── icon-192x192.png
|
||||
│ │ ├── icon-384x384.png
|
||||
│ │ ├── icon-512x512.png
|
||||
│ │ ├── icon-72x72.png
|
||||
│ │ └── icon-96x96.png
|
||||
│ ├── index.md
|
||||
│ ├── javascripts (*)
|
||||
│ │ └── extra.js
|
||||
│ ├── macos
|
||||
│ │ ├── Divers
|
||||
│ │ │ ├── Divers.md
|
||||
│ │ │ ├── Hackintosh.md
|
||||
│ │ │ └── weasyprint.md
|
||||
│ │ └── webserver
|
||||
│ │ ├── apache_M1.md
|
||||
│ │ ├── index.md
|
||||
│ │ ├── install_mysql.md
|
||||
│ │ ├── mysql.md
|
||||
│ │ ├── php.md
|
||||
│ │ └── php80.md
|
||||
│ ├── manifest.json (*)
|
||||
│ ├── overrides (*)
|
||||
│ │ └── partials
|
||||
│ ├── stylesheets (*)
|
||||
│ │ ├── extra.css
|
||||
│ │ ├── fontawesome-all.css
|
||||
│ │ └── second_extra.css
|
||||
│ └── webfonts (*)
|
||||
│ ├── fa-brands-400.eot
|
||||
│ ├── fa-brands-400.svg
|
||||
│ ├── fa-brands-400.ttf
|
||||
│ ├── fa-brands-400.woff
|
||||
│ ├── fa-brands-400.woff2
|
||||
│ ├── fa-regular-400.eot
|
||||
│ ├── fa-regular-400.svg
|
||||
│ ├── fa-regular-400.ttf
|
||||
│ ├── fa-regular-400.woff
|
||||
│ ├── fa-regular-400.woff2
|
||||
│ ├── fa-solid-900.eot
|
||||
│ ├── fa-solid-900.svg
|
||||
│ ├── fa-solid-900.ttf
|
||||
│ ├── fa-solid-900.woff
|
||||
│ └── fa-solid-900.woff2
|
||||
├── includes (*)
|
||||
│ └── abbreviations.md
|
||||
├── mkdocs.yml (*)
|
||||
└── src
|
||||
└── mkdocs-pdf-export-plugin
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
- **assets/**
|
||||
* icons
|
||||
+ icon-128x128.png
|
||||
+ icon-96x96.png
|
||||
|
||||
- **javascripts/**
|
||||
* extra.js
|
||||
|
||||
- Manifest.json
|
||||
|
||||
- **stylesheets/**
|
||||
* extra.css
|
||||
* fontawesome-all.css
|
||||
* second_extra.css
|
||||
|
||||
- **webfonts/**
|
||||
* fa-brands-400.eot
|
||||
* fa-regular-400.eot
|
||||
* fa-solid-900.eot
|
||||
|
||||
- **Includes/**
|
||||
* abbreviations.md
|
||||
|
||||
- mkdocs.yml
|
||||
|
||||
- **overrides/**
|
||||
* partials/
|
||||
|
||||
- **central_docs/** : le site crée par `mkdocs build`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### [suite...:material-arrow-right-top:](mkdocs-material.md)
|
||||
|
||||
192
docs/MkDocs/mkdocs-material-2.md
Normal file
192
docs/MkDocs/mkdocs-material-2.md
Normal file
@@ -0,0 +1,192 @@
|
||||
# Material for MkDocs
|
||||
|
||||
https://squidfunk.github.io/mkdocs-material/
|
||||
|
||||
|
||||
|
||||
### Icons + Emojis
|
||||
|
||||
https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/
|
||||
|
||||
```yaml
|
||||
markdown_extensions:
|
||||
- pymdownx.emoji:
|
||||
emoji_index: !!python/name:materialx.emoji.twemoji
|
||||
emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||
```
|
||||
|
||||
|
||||
|
||||
:material-material-design: [Material Design](https://materialdesignicons.com/)
|
||||
|
||||
:fontawesome-brands-font-awesome: [Font Awesome](https://fontawesome.com/search?m=free)
|
||||
|
||||
:octicons-mark-github-16: [Octicons](https://octicons.github.com/)
|
||||
|
||||
|
||||
|
||||
#### Emojis
|
||||
|
||||
```
|
||||
:smile:
|
||||
|
||||
:angry:
|
||||
|
||||
:deer:
|
||||
```
|
||||
|
||||
:smile:
|
||||
|
||||
:angry:
|
||||
|
||||
:deer:
|
||||
|
||||
|
||||
|
||||
#### Icons
|
||||
|
||||
```
|
||||
:material-phone-classic:
|
||||
|
||||
:fontawesome-solid-phone-flip:
|
||||
|
||||
:octicons-megaphone-24:
|
||||
```
|
||||
|
||||
:material-phone-classic:
|
||||
|
||||
:fontawesome-solid-phone-flip:
|
||||
|
||||
:octicons-megaphone-24:
|
||||
|
||||
|
||||
|
||||
|
||||
### Lists
|
||||
|
||||
https://squidfunk.github.io/mkdocs-material/reference/lists/
|
||||
|
||||
```
|
||||
markdown_extensions:
|
||||
- def_list
|
||||
- pymdownx.tasklist:
|
||||
custom_checkbox: true
|
||||
```
|
||||
|
||||
#### Unordered lists
|
||||
|
||||
```title="List, unordered"
|
||||
- Nulla et rhoncus turpis. Mauris ultricies elementum leo. Duis efficitur
|
||||
accumsan nibh eu mattis. Vivamus tempus velit eros, porttitor placerat nibh
|
||||
lacinia sed. Aenean in finibus diam.
|
||||
|
||||
* Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis.
|
||||
* Nam vulputate tincidunt fringilla.
|
||||
* Nullam dignissim ultrices urna non auctor.
|
||||
|
||||
+ Vivamus venenatis
|
||||
+ Morbi eget dapibus felis.
|
||||
```
|
||||
|
||||
- Nulla et rhoncus turpis. Mauris ultricies elementum leo. Duis efficitur
|
||||
accumsan nibh eu mattis. Vivamus tempus velit eros, porttitor placerat nibh
|
||||
lacinia sed. Aenean in finibus diam.
|
||||
|
||||
* Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis.
|
||||
* Nam vulputate tincidunt fringilla.
|
||||
* Nullam dignissim ultrices urna non auctor.
|
||||
|
||||
+ Vivamus venenatis
|
||||
+ Morbi eget dapibus felis.
|
||||
|
||||
|
||||
|
||||
|
||||
#### Ordered lists
|
||||
|
||||
```title="List, ordered"
|
||||
1. Vivamus id mi enim. Integer id turpis sapien. Ut condimentum lobortis
|
||||
sagittis. Aliquam purus tellus, faucibus eget urna at, iaculis venenatis
|
||||
nulla. Vivamus a pharetra leo.
|
||||
|
||||
1. Vivamus venenatis porttitor tortor sit amet rutrum. Pellentesque aliquet
|
||||
quam enim, eu volutpat urna rutrum a. Nam vehicula nunc mauris, a
|
||||
ultricies libero efficitur sed.
|
||||
|
||||
2. Morbi eget dapibus felis. Vivamus venenatis porttitor tortor sit amet
|
||||
rutrum. Pellentesque aliquet quam enim, eu volutpat urna rutrum a.
|
||||
|
||||
1. Mauris dictum mi lacus
|
||||
2. Ut sit amet placerat ante
|
||||
3. Suspendisse ac eros arcu
|
||||
|
||||
```
|
||||
|
||||
1. Vivamus id mi enim. Integer id turpis sapien. Ut condimentum lobortis
|
||||
sagittis. Aliquam purus tellus, faucibus eget urna at, iaculis venenatis
|
||||
nulla. Vivamus a pharetra leo.
|
||||
1. Vivamus venenatis porttitor tortor sit amet rutrum. Pellentesque aliquet
|
||||
quam enim, eu volutpat urna rutrum a. Nam vehicula nunc mauris, a
|
||||
ultricies libero efficitur sed.
|
||||
2. Morbi eget dapibus felis. Vivamus venenatis porttitor tortor sit amet
|
||||
rutrum. Pellentesque aliquet quam enim, eu volutpat urna rutrum a.
|
||||
|
||||
1. Mauris dictum mi lacus
|
||||
2. Ut sit amet placerat ante
|
||||
3. Suspendisse ac eros arcu
|
||||
|
||||
|
||||
|
||||
#### Task lists
|
||||
|
||||
```title="Task list"
|
||||
- [x] Lorem ipsum dolor sit amet, consectetur adipiscing elit
|
||||
- [ ] Vestibulum convallis sit amet nisi a tincidunt
|
||||
* [x] In hac habitasse platea dictumst
|
||||
* [x] In scelerisque nibh non dolor mollis congue sed et metus
|
||||
* [ ] Praesent sed risus massa
|
||||
- [ ] Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque
|
||||
|
||||
```
|
||||
|
||||
- [x] Lorem ipsum dolor sit amet, consectetur adipiscing elit
|
||||
- [ ] Vestibulum convallis sit amet nisi a tincidunt
|
||||
* [x] In hac habitasse platea dictumst
|
||||
* [x] In scelerisque nibh non dolor mollis congue sed et metus
|
||||
* [ ] Praesent sed risus massa
|
||||
- [ ] Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque
|
||||
|
||||
|
||||
|
||||
#### Definition lists
|
||||
|
||||
```title="Definition list"
|
||||
`Lorem ipsum dolor sit amet`
|
||||
|
||||
: Sed sagittis eleifend rutrum. Donec vitae suscipit est. Nullam tempus
|
||||
tellus non sem sollicitudin, quis rutrum leo facilisis.
|
||||
|
||||
`Cras arcu libero`
|
||||
|
||||
: Aliquam metus eros, pretium sed nulla venenatis, faucibus auctor ex. Proin
|
||||
ut eros sed sapien ullamcorper consequat. Nunc ligula ante.
|
||||
|
||||
Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis.
|
||||
Nam vulputate tincidunt fringilla.
|
||||
Nullam dignissim ultrices urna non auctor.
|
||||
|
||||
```
|
||||
|
||||
`Lorem ipsum dolor sit amet`
|
||||
|
||||
: Sed sagittis eleifend rutrum. Donec vitae suscipit est. Nullam tempus
|
||||
tellus non sem sollicitudin, quis rutrum leo facilisis.
|
||||
|
||||
`Cras arcu libero`
|
||||
|
||||
: Aliquam metus eros, pretium sed nulla venenatis, faucibus auctor ex. Proin
|
||||
ut eros sed sapien ullamcorper consequat. Nunc ligula ante.
|
||||
|
||||
Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis.
|
||||
Nam vulputate tincidunt fringilla.
|
||||
Nullam dignissim ultrices urna non auctor.
|
||||
71
docs/MkDocs/mkdocs-material-3.md
Normal file
71
docs/MkDocs/mkdocs-material-3.md
Normal file
@@ -0,0 +1,71 @@
|
||||
# Material for MkDocs
|
||||
|
||||
https://squidfunk.github.io/mkdocs-material/
|
||||
|
||||
|
||||
|
||||
### Images
|
||||
|
||||
https://squidfunk.github.io/mkdocs-material/reference/images/
|
||||
|
||||
```yaml
|
||||
markdown_extensions:
|
||||
- attr_list
|
||||
- md_in_html
|
||||
```
|
||||
|
||||
|
||||
|
||||
```title="Image, aligned to left"
|
||||
{ align=left }
|
||||
```
|
||||
|
||||
{ align=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.
|
||||
|
||||
|
||||
|
||||
------
|
||||
|
||||
|
||||
|
||||
```title="Image, aligned to right"
|
||||
{ align=right }
|
||||
```
|
||||
|
||||
{ align=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.
|
||||
|
||||
<p {: style="clear: both;"}>
|
||||
|
||||
```title="Image with caption"
|
||||
<figure markdown>
|
||||
{ width="300" }
|
||||
<figcaption>Image caption</figcaption>
|
||||
</figure>
|
||||
```
|
||||
|
||||
<figure markdown>
|
||||
{ width="300" }
|
||||
<figcaption>Image caption</figcaption>
|
||||
</figure>
|
||||
|
||||
{ width="300" }
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
```title="Image, lazy-loaded"
|
||||
{ loading=lazy }
|
||||
```
|
||||
|
||||
{ loading=lazy }
|
||||
590
docs/MkDocs/mkdocs-material.md
Normal file
590
docs/MkDocs/mkdocs-material.md
Normal file
@@ -0,0 +1,590 @@
|
||||
|
||||
|
||||
# Material for MkDocs
|
||||
|
||||
https://squidfunk.github.io/mkdocs-material/
|
||||
|
||||
|
||||
|
||||
### Installer Material
|
||||
|
||||
```bash
|
||||
pip install --upgrade mkdocs-material
|
||||
```
|
||||
|
||||
|
||||
### Installing Python-Markdown
|
||||
|
||||
```bash
|
||||
pip install markdown
|
||||
pip install git+https://github.com/Python-Markdown/markdown.git
|
||||
```
|
||||
|
||||
```bash
|
||||
pip install pymdown-extensions
|
||||
```
|
||||
|
||||
|
||||
|
||||
### pipx
|
||||
|
||||
```bash
|
||||
pipx inject mkdocs mkdocs-material mkdocs-material-extensions mkdocs-minify-plugin mkdocs-git-revision-date-localized-plugin mkdocs-pdf-export-plugin fontawesome_markdown markdown pymdown-extensions
|
||||
```
|
||||
|
||||
|
||||
|
||||
------
|
||||
|
||||
|
||||
|
||||
### Abbreviations
|
||||
|
||||
https://squidfunk.github.io/mkdocs-material/reference/abbreviations/
|
||||
|
||||
```yaml
|
||||
markdown_extensions:
|
||||
- abbr
|
||||
- pymdownx.snippets
|
||||
```
|
||||
|
||||
The HTML specification is maintained by the W3C.
|
||||
|
||||
*[HTML]: Hyper Text Markup Language
|
||||
*[W3C]: World Wide Web Consortium
|
||||
|
||||
|
||||
|
||||
### Glossary
|
||||
|
||||
```yaml
|
||||
markdown_extensions:
|
||||
- abbr
|
||||
- pymdownx.snippets
|
||||
```
|
||||
|
||||
The HTML specification is maintained by the W3C.
|
||||
--8<-- "includes/abbreviations.md"
|
||||
|
||||
|
||||
|
||||
### Admonition
|
||||
|
||||
https://squidfunk.github.io/mkdocs-material/reference/admonitions/
|
||||
|
||||
```yaml
|
||||
markdown_extensions:
|
||||
- admonition
|
||||
- pymdownx.details
|
||||
- pymdownx.superfences
|
||||
```
|
||||
|
||||
#### Note:
|
||||
|
||||
```
|
||||
!!! note
|
||||
```
|
||||
|
||||
!!! 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.
|
||||
|
||||
|
||||
|
||||
#### Collapsible blocks
|
||||
|
||||
```
|
||||
??? note
|
||||
```
|
||||
|
||||
??? 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
|
||||
```
|
||||
|
||||
???+ 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.
|
||||
|
||||
|
||||
|
||||
#### Inline blocks
|
||||
|
||||
##### Aligné à droite:
|
||||
|
||||
```
|
||||
!!! info inline end
|
||||
```
|
||||
|
||||
!!! info inline end
|
||||
|
||||
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.
|
||||
|
||||
**Important**: admonitions that use the `inline` modifiers *must* be declared prior to the content block you want to place them beside. If there's insufficient space to render the admonition next to the block, the admonition will stretch to the full width of the viewport, e.g. on mobile viewports.
|
||||
|
||||
------
|
||||
|
||||
|
||||
|
||||
##### Aligné à gauche:
|
||||
|
||||
```
|
||||
!!! info inline
|
||||
```
|
||||
|
||||
!!! info inline
|
||||
|
||||
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.
|
||||
|
||||
**Important**: admonitions that use the `inline` modifiers *must* be declared prior to the content block you want to place them beside. If there's insufficient space to render the admonition next to the block, the admonition will stretch to the full width of the viewport, e.g. on mobile viewports.
|
||||
|
||||
------
|
||||
|
||||
|
||||
|
||||
#### Titre personnalisé:
|
||||
|
||||
```
|
||||
!!! note "Phasellus posuere in sem ut cursus"
|
||||
```
|
||||
|
||||
!!! note "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.
|
||||
|
||||
|
||||
|
||||
#### Sans titre:
|
||||
|
||||
```
|
||||
!!! note ""
|
||||
```
|
||||
|
||||
!!! 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.
|
||||
|
||||
|
||||
|
||||
#### Supported types
|
||||
|
||||
#### `info` `todo`
|
||||
|
||||
!!! info "Info"
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
`abstract` `summary` `tldr`
|
||||
|
||||
!!! abstract "Info"
|
||||
|
||||
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` `hint` `important`
|
||||
|
||||
!!! tip "Info"
|
||||
|
||||
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` `check` `done`
|
||||
|
||||
!!! success "Info"
|
||||
|
||||
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` `help` `faq`
|
||||
|
||||
!!! question "Info"
|
||||
|
||||
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` `caution` `attention`
|
||||
|
||||
!!! warning "Info"
|
||||
|
||||
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` `fail` `missing`
|
||||
|
||||
!!! failure "Info"
|
||||
|
||||
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` `error`
|
||||
|
||||
!!! danger "Info"
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
`bug`
|
||||
|
||||
!!! bug "Info"
|
||||
|
||||
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`
|
||||
|
||||
!!! example "Info"
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
`quote` `cite`
|
||||
|
||||
!!! quote "Info"
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
### Annotations
|
||||
|
||||
https://squidfunk.github.io/mkdocs-material/reference/annotations/
|
||||
|
||||
|
||||
|
||||
### Buttons
|
||||
|
||||
https://squidfunk.github.io/mkdocs-material/reference/buttons/
|
||||
|
||||
|
||||
|
||||
### Code blocks
|
||||
|
||||
https://squidfunk.github.io/mkdocs-material/reference/code-blocks/
|
||||
|
||||
```yaml
|
||||
markdown_extensions:
|
||||
- pymdownx.highlight:
|
||||
anchor_linenums: true
|
||||
- pymdownx.inlinehilite
|
||||
- pymdownx.snippets
|
||||
- pymdownx.superfences
|
||||
```
|
||||
|
||||
|
||||
|
||||
#### Add a title
|
||||
|
||||
```
|
||||
<shortcode> title="<custom title>"
|
||||
```
|
||||
|
||||
``` py title="bubble_sort.py"
|
||||
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]
|
||||
```
|
||||
|
||||
#### Add line number
|
||||
|
||||
```
|
||||
<shortcode> linenums="<start>"
|
||||
```
|
||||
|
||||
``` py linenums="1"
|
||||
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]
|
||||
```
|
||||
|
||||
#### Highlighting specific lines
|
||||
|
||||
```
|
||||
<shortcode> hl_lines="2 4"
|
||||
```
|
||||
|
||||
``` py hl_lines="2 4"
|
||||
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]
|
||||
```
|
||||
|
||||
#### Highlighting inline code blocks
|
||||
|
||||
```
|
||||
#!<sortcode>
|
||||
```
|
||||
|
||||
The `#!python range()` function is used to generate a sequence of numbers.
|
||||
|
||||
|
||||
|
||||
### Content tabs
|
||||
|
||||
https://squidfunk.github.io/mkdocs-material/reference/content-tabs/
|
||||
|
||||
|
||||
|
||||
### Data tables
|
||||
|
||||
https://squidfunk.github.io/mkdocs-material/reference/data-tables/
|
||||
|
||||
```yam
|
||||
markdown_extensions:
|
||||
- tables
|
||||
```
|
||||
|
||||
#### Aligner une colonne à gauche
|
||||
|
||||
```markdown
|
||||
| Method | Description |
|
||||
| :---------- | :----------------------------------- |
|
||||
| `GET` | :material-check: Fetch resource |
|
||||
| `PUT` | :material-check-all: Update resource |
|
||||
| `DELETE` | :material-close: Delete resource |
|
||||
```
|
||||
|
||||
| Method | Description |
|
||||
| :------- | :----------------------------------- |
|
||||
| `GET` | :material-check: Fetch resource |
|
||||
| `PUT` | :material-check-all: Update resource |
|
||||
| `DELETE` | :material-close: Delete resource |
|
||||
|
||||
#### Aligner une colonne au centre
|
||||
|
||||
```markdown
|
||||
| Method | Description |
|
||||
| :---------: | :----------------------------------: |
|
||||
| `GET` | :material-check: Fetch resource |
|
||||
| `PUT` | :material-check-all: Update resource |
|
||||
| `DELETE` | :material-close: Delete resource |
|
||||
```
|
||||
|
||||
| Method | Description |
|
||||
| :------: | :----------------------------------: |
|
||||
| `GET` | :material-check: Fetch resource |
|
||||
| `PUT` | :material-check-all: Update resource |
|
||||
| `DELETE` | :material-close: Delete resource |
|
||||
|
||||
#### Aligner une colonne à droite
|
||||
|
||||
```markdown
|
||||
| Method | Description |
|
||||
| ----------: | -----------------------------------: |
|
||||
| `GET` | :material-check: Fetch resource |
|
||||
| `PUT` | :material-check-all: Update resource |
|
||||
| `DELETE` | :material-close: Delete resource |
|
||||
```
|
||||
|
||||
| Method | Description |
|
||||
| -------: | -----------------------------------: |
|
||||
| `GET` | :material-check: Fetch resource |
|
||||
| `PUT` | :material-check-all: Update resource |
|
||||
| `DELETE` | :material-close: Delete resource |
|
||||
|
||||
#### Trier une colonne
|
||||
|
||||
```yaml
|
||||
extra_javascript:
|
||||
- https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
|
||||
- javascripts/tablesort.js
|
||||
```
|
||||
|
||||
|
||||
|
||||
| Method | Description |
|
||||
| -------- | ------------------------------------ |
|
||||
| `GET` | :material-check: Fetch resource |
|
||||
| `PUT` | :material-check-all: Update resource |
|
||||
| `DELETE` | :material-close: Delete resource |
|
||||
|
||||
### Diagrams
|
||||
|
||||
https://squidfunk.github.io/mkdocs-material/reference/diagrams/
|
||||
|
||||
|
||||
|
||||
### Footnotes
|
||||
|
||||
https://squidfunk.github.io/mkdocs-material/reference/footnotes/
|
||||
|
||||
```yaml
|
||||
markdown_extensions:
|
||||
- footnotes
|
||||
```
|
||||
|
||||
#### Adding footnote references
|
||||
|
||||
```
|
||||
Lorem ipsum[^1] dolor sit amet, consectetur adipiscing elit.[^2]
|
||||
```
|
||||
|
||||
Lorem ipsum[^1] dolor sit amet, consectetur adipiscing elit.[^2]
|
||||
|
||||
#### Adding footnote content
|
||||
|
||||
```
|
||||
[^1]: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
||||
```
|
||||
|
||||
[^1]: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
||||
|
||||
[Footnote 1](#fn:1)
|
||||
|
||||
```
|
||||
[^2]:
|
||||
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.
|
||||
```
|
||||
|
||||
[^2]:
|
||||
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.
|
||||
|
||||
[Footnote 2](#fn:2)
|
||||
|
||||
|
||||
|
||||
### Formatting
|
||||
|
||||
https://squidfunk.github.io/mkdocs-material/reference/formatting/
|
||||
|
||||
```yaml
|
||||
markdown_extensions:
|
||||
- pymdownx.critic
|
||||
- pymdownx.caret
|
||||
- pymdownx.keys
|
||||
- pymdownx.mark
|
||||
- pymdownx.tilde
|
||||
```
|
||||
|
||||
#### Highlighting changes
|
||||
|
||||
```
|
||||
Text can be {--deleted--} and replacement text {++added++}. This can also be
|
||||
combined into {~~one~>a single~~} operation. {==Highlighting==} is also
|
||||
possible {>>and comments can be added inline<<}.
|
||||
|
||||
{==
|
||||
|
||||
Formatting can also be applied to blocks by putting the opening and closing
|
||||
tags on separate lines and adding new lines between the tags and the content.
|
||||
|
||||
==}
|
||||
```
|
||||
|
||||
Text can be {--deleted--} and replacement text {++added++}. This can also be
|
||||
combined into {~~one~>a single~~} operation. {==Highlighting==} is also
|
||||
possible {>>and comments can be added inline<<}.
|
||||
|
||||
{==
|
||||
|
||||
Formatting can also be applied to blocks by putting the opening and closing
|
||||
tags on separate lines and adding new lines between the tags and the content.
|
||||
|
||||
==}
|
||||
|
||||
#### Highlighting text
|
||||
|
||||
```
|
||||
- ==This was marked==
|
||||
- ^^This was inserted^^
|
||||
- ~~This was deleted~~
|
||||
```
|
||||
|
||||
- ==This was marked==
|
||||
- ^^This was inserted^^
|
||||
- ~~This was deleted~~
|
||||
|
||||
#### Sub- and superscripts
|
||||
|
||||
```
|
||||
- H~2~0
|
||||
- A^T^A
|
||||
```
|
||||
|
||||
- H~2~0
|
||||
- A^T^A
|
||||
|
||||
#### Keys
|
||||
|
||||
```
|
||||
++ctrl+alt+del++
|
||||
|
||||
++cmd+alt+"Ü"++
|
||||
|
||||
++cmd++
|
||||
```
|
||||
|
||||
++ctrl+alt+"My Special Key"++
|
||||
|
||||
++cmd+alt+"Ü"++
|
||||
|
||||
++cmd++
|
||||
|
||||
|
||||
|
||||
[suite...:material-arrow-right-top:](mkdocs-material-2.md)
|
||||
|
||||
###
|
||||
Reference in New Issue
Block a user