{"id":40864727,"url":"https://github.com/ruslanlap/mkdocs-catppuccin","last_synced_at":"2026-01-22T00:16:27.633Z","repository":{"id":330453701,"uuid":"1101970388","full_name":"ruslanlap/mkdocs-catppuccin","owner":"ruslanlap","description":"MkDocs Catppuccin Theme - This project provides a complete integration of the Catppuccin color palette with MkDocs Material theme. Users can seamlessly switch between all 4 Catppuccin flavors directly from the documentation interface.","archived":false,"fork":false,"pushed_at":"2025-12-25T15:17:44.000Z","size":32906,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-12-27T02:28:30.873Z","etag":null,"topics":["catppuccin","catppuccin-palette","catppuccin-theme","mkdocs","mkdocs-material"],"latest_commit_sha":null,"homepage":"https://ruslanlap.github.io/mkdocs-catppuccin/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ruslanlap.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-22T15:24:44.000Z","updated_at":"2025-12-25T15:17:28.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/ruslanlap/mkdocs-catppuccin","commit_stats":null,"previous_names":["ruslanlap/mkdocs-catppuccin"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/ruslanlap/mkdocs-catppuccin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruslanlap%2Fmkdocs-catppuccin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruslanlap%2Fmkdocs-catppuccin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruslanlap%2Fmkdocs-catppuccin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruslanlap%2Fmkdocs-catppuccin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ruslanlap","download_url":"https://codeload.github.com/ruslanlap/mkdocs-catppuccin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruslanlap%2Fmkdocs-catppuccin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28647914,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-21T21:29:11.980Z","status":"ssl_error","status_checked_at":"2026-01-21T21:24:31.872Z","response_time":86,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["catppuccin","catppuccin-palette","catppuccin-theme","mkdocs","mkdocs-material"],"created_at":"2026-01-22T00:16:27.139Z","updated_at":"2026-01-22T00:16:27.626Z","avatar_url":"https://github.com/ruslanlap.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MkDocs Catppuccin Theme\n\n\u003cdiv align=\"center\"\u003e\n\n\u003csamp\u003e\n\nBeautiful MkDocs documentation with all 4 Catppuccin flavors\n\n\u003c/samp\u003e\n\n[![MkDocs](https://img.shields.io/badge/MkDocs-Material-blue)](https://squidfunk.github.io/mkdocs-material/)\n[![Catppuccin](https://img.shields.io/badge/Catppuccin-Theme-pink)](https://github.com/catppuccin/catppuccin)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Deploy](https://github.com/ruslanlap/mkdocs-catppuccin/actions/workflows/deploy.yml/badge.svg)](https://github.com/ruslanlap/mkdocs-catppuccin/actions/workflows/deploy.yml)\n\n**[📚 Live Demo](https://ruslanlap.github.io/mkdocs-catppuccin/)** • **[📖 Documentation](https://ruslanlap.github.io/mkdocs-catppuccin/configuration/)** • **[🎨 Catppuccin](https://github.com/catppuccin/catppuccin)**\n\n\u003c/div\u003e\n\n---\n\n## Overview\n\nThis project provides a complete integration of the **Catppuccin** color palette with **MkDocs Material** theme. Users can seamlessly switch between all 4 Catppuccin flavors directly from the documentation interface.\n\n### Available Flavors\n\n| Flavor | Type | Base Color | Description |\n|--------|------|------------|-------------|\n| **Latte** 🌅 | Light | `#eff1f5` | Light theme for daytime work |\n| **Frappé** 🌆 | Dark | `#303446` | Cool dark theme |\n| **Macchiato** 🌃 | Dark | `#24273a` | Warm dark theme |\n| **Mocha** 🌌 | Dark | `#1e1e2e` | Warmest dark theme |\n\n## Features\n\n- ✨ **All 4 Catppuccin Flavors** - Complete color palette support\n- 🎨 **Seamless Theme Switching** - Toggle between flavors with one click\n- 📝 **Optimized Code Highlighting** - Beautiful syntax colors for all languages\n- 🎯 **Full Material Integration** - All Material for MkDocs features supported\n- 📱 **Responsive Design** - Perfect on desktop, tablet, and mobile\n- ♿ **Accessibility** - WCAG AA compliant color contrasts\n- 🔍 **Enhanced Search** - Themed search interface\n- 📦 **Easy to Use** - Simple copy-paste integration\n\n## Quick Start\n\n### Prerequisites\n\n```bash\npip install mkdocs mkdocs-material\n```\n\n### Installation\n\n1. **Clone or download this repository**\n\n```bash\ngit clone https://github.com/yourusername/mkdocs-catppuccin.git\ncd mkdocs-catppuccin\n```\n\n2. **Copy the files to your project**\n\n```bash\n# Copy the CSS file\ncp -r docs/stylesheets your-project/docs/\n\n# Use the mkdocs.yml as reference\n```\n\n3. **Update your `mkdocs.yml`**\n\n```yaml\ntheme:\n  name: material\n  palette:\n    - scheme: latte\n      primary: custom\n      accent: custom\n      toggle:\n        icon: material/weather-sunny\n        name: Switch to Frappé\n\n    - scheme: frappe\n      primary: custom\n      accent: custom\n      toggle:\n        icon: material/weather-night\n        name: Switch to Macchiato\n\n    - scheme: macchiato\n      primary: custom\n      accent: custom\n      toggle:\n        icon: material/weather-partly-cloudy\n        name: Switch to Mocha\n\n    - scheme: mocha\n      primary: custom\n      accent: custom\n      toggle:\n        icon: material/weather-cloudy\n        name: Switch to Latte\n\nextra_css:\n  - stylesheets/extra.css\n```\n\n4. **Serve locally**\n\n```bash\nmkdocs serve\n```\n\nVisit `http://127.0.0.1:8000` to see your documentation with Catppuccin themes!\n\n## Project Structure\n\n```\nmkdocs-catppuccin/\n├── docs/\n│   ├── stylesheets/\n│   │   └── extra.css          # All 4 Catppuccin flavors\n│   ├── index.md                # Home page\n│   └── configuration.md        # Configuration guide\n├── mkdocs.yml                  # MkDocs configuration\n└── README.md                   # This file\n```\n\n## Documentation\n\nThis project includes comprehensive documentation:\n\n- **[🌐 Live Demo](https://ruslanlap.github.io/mkdocs-catppuccin/)** - See all 4 Catppuccin flavors in action!\n- **[Home Page](https://ruslanlap.github.io/mkdocs-catppuccin/)** - Overview and examples\n- **[Configuration Guide](https://ruslanlap.github.io/mkdocs-catppuccin/configuration/)** - Step-by-step setup instructions\n\n## Screenshots\n\n### Latte (Light Theme)\nBright and clean theme perfect for daytime reading and work.\n\n### Frappé (Dark Theme)\nCool dark theme with balanced contrast for extended coding sessions.\n\n### Macchiato (Dark Theme)\nWarm dark theme comfortable for evening use.\n\n### Mocha (Dark Theme)\nDeep, cozy dark theme ideal for late-night coding.\n\n## Customization\n\n### Changing Colors\n\nYou can customize the primary and accent colors in `docs/stylesheets/extra.css`:\n\n```css\n[data-md-color-scheme=\"mocha\"] {\n  /* Change primary color to green */\n  --md-primary-fg-color: var(--ctp-mocha-green);\n\n  /* Change accent color to teal */\n  --md-accent-fg-color: var(--ctp-mocha-teal);\n}\n```\n\n### Available Colors\n\nEach flavor includes these colors:\n\n- **Backgrounds**: `base`, `mantle`, `crust`\n- **Surfaces**: `surface0`, `surface1`, `surface2`\n- **Overlays**: `overlay0`, `overlay1`, `overlay2`\n- **Text**: `subtext0`, `subtext1`, `text`\n- **Colors**: `lavender`, `blue`, `sapphire`, `sky`, `teal`, `green`, `yellow`, `peach`, `maroon`, `red`, `mauve`, `pink`, `flamingo`, `rosewater`\n\nSee the [Configuration Guide](docs/configuration.md) for more customization options.\n\n## Deployment\n\n### GitHub Pages\n\nCreate `.github/workflows/deploy.yml`:\n\n```yaml\nname: Deploy MkDocs\n\non:\n  push:\n    branches:\n      - main\n\npermissions:\n  contents: write\n\njobs:\n  deploy:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n      - uses: actions/setup-python@v5\n        with:\n          python-version: 3.x\n      - run: pip install mkdocs-material\n      - run: mkdocs gh-deploy --force\n```\n\n### Other Platforms\n\n```bash\nmkdocs build\n# Upload the 'site/' directory to your hosting provider\n```\n\n## Contributing\n\nContributions are welcome! Here's how you can help:\n\n1. Fork the repository\n2. Create a feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## Troubleshooting\n\n### Theme not applying?\n- Check that `extra.css` is in `docs/stylesheets/`\n- Verify the path in `mkdocs.yml` is correct\n- Clear browser cache with `Ctrl+F5`\n\n### Colors look wrong?\n- Ensure `scheme` names match between `mkdocs.yml` and CSS\n- Check for CSS syntax errors\n- Verify all color variables are defined\n\n### Toggle not working?\n- Make sure you have multiple palettes defined\n- Check that each palette has a unique `scheme` name\n- Verify the `toggle` sections are properly configured\n\nFor more help, see the [Configuration Guide](docs/configuration.md).\n\n## Resources\n\n- [Catppuccin Official Website](https://catppuccin.com/)\n- [Catppuccin GitHub](https://github.com/catppuccin/catppuccin)\n- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)\n- [MkDocs Documentation](https://www.mkdocs.org/)\n- [Catppuccin Style Guide](https://github.com/catppuccin/catppuccin/blob/main/docs/style-guide.md)\n\n## Credits\n\n- **[Catppuccin](https://github.com/catppuccin/catppuccin)** - The beautiful color palette\n- **[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)** - The amazing documentation theme\n- **[MkDocs](https://www.mkdocs.org/)** - The static site generator\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\nCatppuccin is licensed under the MIT License.\n\n---\n\n\u003cdiv align=\"center\"\u003e\n\n**Made with ☕ and Catppuccin**\n\nIf you find this useful, consider ⭐ starring the repository!\n\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruslanlap%2Fmkdocs-catppuccin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fruslanlap%2Fmkdocs-catppuccin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruslanlap%2Fmkdocs-catppuccin/lists"}