mkdocs setup with mkdocs-material Part-1

Installation (For linux server)

1. Install python3-pip

sudo apt install python3-pip

2. Install mkdocs (v1.1) with pip3

pip3 install mkdocs

You can check the version using the command: mkdocs -V

3. Install mkdocs material : pip3 install mkdocs-material

Project creation and adding mkdocs-material theme

1. Create the project name project-doc using the command: mkdocs new project-doc

2. The mkdocs project directory will be created with
project-doc/
├── docs
│ └── index.md
└── mkdocs.yml

1 directory, 2 files

3. Navigate to project-doc directory: cd project-doc

4. Add the mkdocs-material theme . Edit the mkdocs.yml to include below content and save it

site_name: My project docs
theme:
name: material

5. Run the mkdocs server using the command: mkdocs-serve

You can find the samples in Github https://github.com/pradeeppadmarajaiah/mkdocs/tree/master/samples/

Part 2 :mkdocs (Understanding markdown documentation creation) Part-2

https://medium.com/@pradeep.padmarajaiah/mkdocs-understanding-markdown-documentation-creation-part-2-43c82c387cfe