Documentation: MkDocs - devrath/RunTracer GitHub Wiki

`Website`

`Steps`

Install Python: Run the following command to install Python via Homebrew:
```
brew install python
```
Verify Installation: After installation, verify that Python is correctly installed and accessible:
```
python3 --version
```
Create a Virtual Environment: Use python3 instead of python to create the virtual environment:
```
python3 -m venv venv
```
Activate it:
```
source venv/bin/activate
```
Check it python is installed:
```
pip --version
```
Install mkdocs:
```
pip install mkdocs-material
```
Create mkdocs website:
```
mkdocs new .
```

Run the website:

mkdocs serve

Output:

INFO    -  Building documentation...
INFO    -  Cleaning site directory
INFO    -  Doc file 'static_analysis.md' contains an absolute link '/config/detekt/detekt.yml', it was left as is.
INFO    -  Documentation built in 0.03 seconds
INFO    -  [20:42:24] Watching paths for changes: 'docs', 'mkdocs.yml'
INFO    -  [20:42:24] Serving on http://127.0.0.1:8000/
INFO    -  [20:42:31] Browser connected: http://127.0.0.1:8000/

Now paste http://127.0.0.1:8000/ in your browser and enter

`Install Material`

Edit the mkdocs.yml

site_name: My Docs
theme:
  name: material

`Useful Source`

Tutorial-Documentation With MkDocs Material Theme