-
Install MkDocs and required plugins:
pip install mkdocs mkdocs-material
-
Clone this repository:
git clone https://github.com/yourusername/your-repo-name.git cd your-repo-name
-
Run development server:
mkdocs serve
-
Build the site:
mkdocs build
-
Deploy to GitHub Pages:
mkdocs gh-deploy
docs/
: Contains all pages and blog postsmkdocs.yml
: Configuration file
- Add new pages to
docs/
- Add blog posts to
docs/posts/
- Update
mkdocs.yml
as needed
For more details, refer to the MkDocs documentation.