https://github.com/stevedev7/mkdocs-101
Repo to implement and play around with mkdocs.
https://github.com/stevedev7/mkdocs-101
github-actions mkdocs mkdocs-material
Last synced: about 1 month ago
JSON representation
Repo to implement and play around with mkdocs.
- Host: GitHub
- URL: https://github.com/stevedev7/mkdocs-101
- Owner: Stevedev7
- Created: 2025-04-02T13:01:07.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2025-04-02T16:03:50.000Z (about 1 month ago)
- Last Synced: 2025-04-02T17:22:36.721Z (about 1 month ago)
- Topics: github-actions, mkdocs, mkdocs-material
- Homepage: https://stevedev7.github.io/mkdocs-101/
- Size: 7.55 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MkDocs Demo
This repository is for learning how to set up a documentation website using Mkdocs.
I'll be using [Material](https://squidfunk.github.io/mkdocs-material/) theme for this.
## Steps to run locally
1) Create a python virtual environment
```bash
python3 -m venv venv
```
1) Activate the virtual environment
```bash
source venv/bin/activate
```
1) Install dependancies.
```bash
pip install -r requirements.txt
```
1) Spin up a dev server.
```bash
mkdocs serve
```
1) Your docs are served on .