A blog about Machine Learning tips, tricks, and experiences, built with MkDocs and hosted on GitHub Pages.
- MkDocs - Static site generator
- Material for MkDocs - Beautiful theme
- GitHub Pages - Hosting
- GitHub Actions - Automated deployment
-
Clone the repository:
git clone <your-repo-url> cd <repo-name>
-
Set up the development environment:
make setup # Creates venv and installs dependencies source .venv/bin/activate
-
Start the development server:
make serve
-
Visit
http://127.0.0.1:8000in your browser
Blog posts are written in Markdown and stored in the docs/ directory. To create a new post:
- Create a new
.mdfile in thedocs/directory - Add the file to the navigation in
mkdocs.yml - Write your content using Markdown
make help- Show all available commandsmake setup- Create new venv and install dependenciesmake serve- Start the development servermake build- Build the static sitemake clean- Remove the built sitemake venv- Create a new virtual environmentmake clean-venv- Remove the virtual environment
All dependencies are listed in requirements.txt. Main dependencies:
- mkdocs
- mkdocs-material
This project is open source and available under the MIT License.