Installez mkdocs

Référence: Création de document avec MkDocs --Qiita

#installer
> pip install mkdocs
Collecting mkdocs
  Downloading mkdocs-1.1.2-py3-none-any.whl (6.4 MB)
     |████████████████████████████████| 6.4 MB 726 kB/s
# ...réduction...
Successfully installed Jinja2-2.11.2 Markdown-3.2.2 MarkupSafe-1.1.1 PyYAML-5.3.1 click-7.1.2 joblib-0.17.0 livereload-2.6.3 lunr-0.5.8 mkdocs-1.1.2 nltk-3.5 regex-2020.9.27 tornado-6.0.4 tqdm-4.50.0

#Vérifier la version
> mkdocs -V
mkdocs, version 1.1.2 from c:\path\to\venv\lib\site-packages\mkdocs (Python 3.8)

Créer un projet

Le mkdocs.yml créé lorsque vous créez un projet devient le fichier de configuration

#Lorsque vous créez un projet avec le nom de projet "docs"
> mkdocs new docs
INFO    -  Creating project directory: docs
INFO    -  Writing config file: docs\mkdocs.yml
INFO    -  Writing initial docs: docs\docs\index.md

#Un répertoire avec le nom du projet est créé
> ls -la | grep docs
drwxr-xr-x 1 m-ukigaya 1049089 0 5 octobre 12:55 docs/

# index.md et mkdocs.yml est créé
> find docs/ -type f
docs/docs/index.md
docs/mkdocs.yml

Construire et afficher dans le navigateur

#Accédez au répertoire de votre projet
> cd docs

#Construire
> mkdocs build
INFO    -  Cleaning site directory
INFO    -  Building documentation to directory: C:\path\to\docs\site
INFO    -  Documentation built in 0.11 seconds

#Démarrez le serveur
> mkdocs serve
INFO    -  Building documentation...
INFO    -  Cleaning site directory
INFO    -  Documentation built in 0.12 seconds
[I 201005 13:00:32 server:335] Serving on http://127.0.0.1:8000
INFO    -  Serving on http://127.0.0.1:8000
[I 201005 13:00:32 handlers:62] Start watching changes
INFO    -  Start watching changes
[I 201005 13:00:32 handlers:64] Start detecting changes
INFO    -  Start detecting changes
[I 201005 13:00:41 handlers:135] Browser Connected: http://127.0.0.1:8000/
INFO    -  Browser Connected: http://127.0.0.1:8000/
#Ctrl lorsque vous souhaitez arrêter le serveur+ C

Remarque: démarrez le serveur avec mkdocs serve au lieu de mkdocs server. Je n'ai pas besoin de "r".

> mkdocs server
Usage: mkdocs [OPTIONS] COMMAND [ARGS]...
Try 'mkdocs -h' for help.

Error: No such command 'server'.

Lorsque la sortie [http://127.0.0.1:8000/] de mkdocs serve est affichée sur le navigateur, cela ressemble à ceci

installer le thème matériel

--Référence: Commençons par mkdocs qui peuvent facilement créer des documents --Qiita

Installez un thème qui définit l'apparence. Cette fois, j'essaierai d'utiliser le "matériel" introduit sur d'autres sites. Peu m'importe si Exigence déjà satisfaite: ... s'affiche pendant l'installation car c'est comme "Je suis déjà installé".

> pip install mkdocs-material
Collecting mkdocs-material
  Downloading mkdocs_material-6.0.2-py2.py3-none-any.whl (3.9 MB)
     |████████████████████████████████| 3.9 MB 86 kB/s
# ...réduction...
Requirement already satisfied: regex in c:\path\to\venv\lib\site-packages (from nltk>=3.2.5; python_version > "2.7" and extra == "languages"->lunr[languages]==0.5.8->mkdocs>=1.1->mkdocs-material) (2020.9.27)
Installing collected packages: Pygments, pymdown-extensions, mkdocs-material-extensions, mkdocs-material
Successfully installed Pygments-2.7.1 mkdocs-material-6.0.2 mkdocs-material-extensions-1.0.1 pymdown-extensions-8.0.1

> pip list
Package                    Version
-------------------------- ---------
...
mkdocs                     1.1.2
mkdocs-material            6.0.2
mkdocs-material-extensions 1.0.1
...
Pygments                   2.7.1

Définissez le thème dans mkdocs.yml

Ouvrez mkdocs.yml créé lors de la création du projet
Ajouter "thème: 'matériel'"
Pour les autres parties, [Commençons par mkdocs qui peuvent facilement créer des documents --Qiita](https://qiita.com/wamisnet/items/ed725d74f945f7c06b91#%E3%81%9B%E3%81%A3%E3%81 % 8B% E3% 81% 8F% E3% 81% AA% E3% 81% AE% E3% 81% A7mkdocs% E3% 82% 92material-design% E3% 81% AB% E3% 81% 97% E3% 81 % A6% E3% 81% BF% E3% 82% 88% E3% 81% 86)

# Project information
site_name: 'Nom du site'

# Documentation and theme
docs_dir: 'docs'
theme: 'material'

# Extensions
markdown_extensions:
  - admonition
  - toc:
      permalink: '#'

Démarrez également le serveur et essayez de l'afficher avec un navigateur.

Démarrez le serveur avec mkdocs serve
Lorsque j'ai essayé d'afficher le serveur avec la sortie URL au démarrage, il a changé en quelque chose comme ça