Installieren Sie mkdocs

Referenz: Dokumenterstellung mit MkDocs - Qiita

#Installieren
> pip install mkdocs
Collecting mkdocs
  Downloading mkdocs-1.1.2-py3-none-any.whl (6.4 MB)
     |████████████████████████████████| 6.4 MB 726 kB/s
# ...Kürzung...
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

#Version prüfen
> mkdocs -V
mkdocs, version 1.1.2 from c:\path\to\venv\lib\site-packages\mkdocs (Python 3.8)

Erstellen Sie ein Projekt

Die beim Erstellen eines Projekts erstellte mkdocs.yml wird zur Konfigurationsdatei

#Wenn Sie ein Projekt mit dem Projektnamen "docs" erstellen
> mkdocs new docs
INFO    -  Creating project directory: docs
INFO    -  Writing config file: docs\mkdocs.yml
INFO    -  Writing initial docs: docs\docs\index.md

#Ein Verzeichnis mit dem Projektnamen wird erstellt
> ls -la | grep docs
drwxr-xr-x 1 m-ukigaya 1049089 0 5. Oktober 12:55 docs/

# index.md und mkdocs.yml wird erstellt
> find docs/ -type f
docs/docs/index.md
docs/mkdocs.yml

Erstellen und im Browser anzeigen

#Gehen Sie zu Ihrem Projektverzeichnis
> cd docs

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

#Starten Sie den Server
> 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/
#Strg, wenn Sie den Server stoppen möchten+ C

Hinweis: Starten Sie den Server mit "mkdocs serve" anstelle von "mkdocs server". Ich brauche kein "r".

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

Error: No such command 'server'.

Wenn die [http://127.0.0.1:8000/] Ausgabe von mkdocs serve im Browser angezeigt wird, sieht es so aus

Installieren Sie das Materialthema

--Referenz: Beginnen wir mit mkdocs, mit denen problemlos Dokumente erstellt werden können - Qiita

Installieren Sie ein Thema, das das Erscheinungsbild festlegt. Dieses Mal werde ich versuchen, "Material" zu verwenden, das auf anderen Websites eingeführt wurde. Es ist mir egal, ob "Anforderung bereits erfüllt: ..." während der Installation angezeigt wird, da es sich um "Ich bin bereits installiert" handelt.

> 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
# ...Kürzung...
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

Legen Sie das Thema in mkdocs.yml fest

Öffnen Sie mkdocs.yml, das beim Erstellen des Projekts erstellt wurde
Fügen Sie "theme: 'material'" hinzu.
Für andere Teile [Starten wir mkdocs, mit denen Dokumente einfach erstellt werden können - 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: 'Site-Name'

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

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

Starten Sie außerdem den Server und versuchen Sie, ihn mit einem Browser anzuzeigen.

Starten Sie den Server mit mkdocs serve
Als ich versuchte, den Server mit der URL-Ausgabe beim Start anzuzeigen, wurde er in etwa so geändert