Skip to content

About

About This Site

This is a personal site built with Material for MkDocs, a powerful documentation framework with Jupyter notebook support.

Features

  • 🎨 Material Design - Beautiful, responsive theme
  • 📓 Jupyter Notebooks - Render .ipynb files directly
  • 🚀 Auto-Deploy - Cloudflare Pages deployment on push to master branch
  • 🌙 Dark Mode - Toggle between light and dark themes
  • 🔍 Search - Full-text search with highlighting
  • 💻 Code Blocks - Syntax highlighting with copy button
  • 📱 Mobile-Friendly - Responsive design for all devices

Technologies Used

MkDocs Material

Material for MkDocs provides:

  • Beautiful, responsive design
  • Advanced navigation features
  • Code syntax highlighting
  • Extensions for admonitions, tabs, and more

MkDocs Jupyter

The mkdocs-jupyter plugin enables embedding Jupyter notebooks directly, perfect for:

  • Data science tutorials
  • Code demonstrations
  • Technical documentation with executable examples

Deployment

The site automatically deploys to Cloudflare Pages when changes are pushed to the master branch.

Adding Content

Markdown Pages

  1. Create a new .md file in docs/
  2. Add it to navigation in mkdocs.yml:
nav:
  - Home: index.md
  - Your Page: your-page.md

Jupyter Notebooks

  1. Add .ipynb file to docs/
  2. Reference in mkdocs.yml navigation
  3. It will be automatically rendered

For customization options, see the Customization Guide.