Source code for my personal website driuft.com, built with MkDocs. This repository is open-sourced to share my site's configuration and implementation.
- Framework: MkDocs - A fast, simple static site generator
- Theme: Customized Material theme
- Deployment: GitHub Pages
- Additional Features:
- Custom CSS styling
- Web fonts integration
- Responsive design optimizations
driuft.com/
├── docs/ # Main documentation content
│ ├── assets/ # Shared assets like images and fonts
│ │ ├── fonts/ # Custom fonts
│ │ └── images/ # General image files
│ ├── blog/ # Blog section
│ │ ├── posts/ # Individual blog posts
│ │ │ └── images/ # Images specific to blog posts
│ │ └── index.md # Blog index page
│ ├── experience/ # Professional work experience
│ │ └── index.md # Work experience content page
│ ├── speaking/ # Speaking engagements and talks
│ │ └── index.md # Speaking overview page
│ ├── stylesheets/ # Custom CSS files
│ │ └── extra.css # Additional CSS configurations
│ └── index.md # Homepage content
├── includes/ # Global features
│ └── abbreviations.md # List of global abbreviations
├── mkdocs.yml # MkDocs configuration file
└── README.md # Project overview and instructions
If you want to run this site locally:
- Python 3.x
- pip (Python package installer)
-
Clone the repository:
git clone https://github.com/driuft/driuft.com.git cd driuft.com -
Install MkDocs and dependencies:
pip install -r requirements.txt
-
Run the development server:
mkdocs serve
-
View the site locally at
http://127.0.0.1:8000/
The site is configured in mkdocs.yml, which includes:
- Theme settings
- Navigation structure
- Plugin configurations
- Custom styling options
The site is deployed to GitHub Pages through GitHub Actions. The workflow automatically builds and deploys the site when changes are pushed to the main branch.
This project is licensed under the MIT License - see the LICENSE file for details. Feel free to use this configuration as inspiration for your own MkDocs projects.