--Environment --Windows10 Pro version 1909 - Python 3.8.5 -Click here for Python installation record - pip 20.2.3

Install mkdocs

Reference: Document creation with MkDocs --Qiita

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

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

Create a project

The mkdocs.yml created when you create a project becomes the configuration file

#When you create a project with the project name "docs"
> mkdocs new docs
INFO    -  Creating project directory: docs
INFO    -  Writing config file: docs\mkdocs.yml
INFO    -  Writing initial docs: docs\docs\index.md

#A directory with the project name is created
> ls -la | grep docs
drwxr-xr-x 1 m-ukigaya 1049089 0 October 5 12:55 docs/

# index.md and mkdocs.yml is created
> find docs/ -type f
docs/docs/index.md
docs/mkdocs.yml

Build it and display it in a browser

#Go to your project directory
> cd docs

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

#Start the 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/
#Ctrl when you want to stop the server+ C

Note: Start the server with mkdocs serve instead of mkdocs server. I don't need "r".

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

Error: No such command 'server'.

When [http://127.0.0.1:8000/] output by mkdocs serve is displayed on the browser, it looks like this

install the material theme

--Reference: Let's start mkdocs that can easily create documents --Qiita

Install a theme that sets the appearance. This time, I will try using material introduced on other sites. I don't care if Requirement already satisfied: ... is displayed during installation because it's like "I'm already installed".

> 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
# ...abridgement...
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

Set the theme in mkdocs.yml

Open mkdocs.yml created when creating the project
Add "theme:'material'"
For other parts, [Let's start mkdocs that can easily create 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) ... or rather copy

# Project information
site_name: 'Site name'

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

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

Also, start the server and try to display it with a browser.

Start the server with mkdocs serve
When I tried to display the server with the URL output at startup, it changed like this