{"id":37065186,"url":"https://github.com/ruslanlap/catppuccin-mkdocs","last_synced_at":"2026-01-14T07:37:51.090Z","repository":{"id":325514466,"uuid":"1101483140","full_name":"ruslanlap/catppuccin-mkdocs","owner":"ruslanlap","description":null,"archived":false,"fork":false,"pushed_at":"2025-11-21T20:10:06.000Z","size":24,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-11-21T20:29:32.872Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","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":"LICENSE","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-21T18:32:28.000Z","updated_at":"2025-11-21T20:10:02.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/ruslanlap/catppuccin-mkdocs","commit_stats":null,"previous_names":["ruslanlap/catppuccin-mkdocs"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/ruslanlap/catppuccin-mkdocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruslanlap%2Fcatppuccin-mkdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruslanlap%2Fcatppuccin-mkdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruslanlap%2Fcatppuccin-mkdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruslanlap%2Fcatppuccin-mkdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ruslanlap","download_url":"https://codeload.github.com/ruslanlap/catppuccin-mkdocs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruslanlap%2Fcatppuccin-mkdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28413457,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T05:26:33.345Z","status":"ssl_error","status_checked_at":"2026-01-14T05:21:57.251Z","response_time":107,"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":[],"created_at":"2026-01-14T07:37:50.404Z","updated_at":"2026-01-14T07:37:51.080Z","avatar_url":"https://github.com/ruslanlap.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🎨 MkDocs Catppuccin Theme\n\u003cp align=\"center\"\u003e\u003cimg src=\"mkdocs_catppuccin/assets/logo.png\" width=\"200\" alt=\"Catppuccin MkDocs Logo\"/\u003e\u003c/p\u003e\n\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/palette/macchiato.png\" width=\"400\" alt=\"Catppuccin Palette\"/\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://ruslanlap.github.io/Catppuccin-MkDocs/\"\u003e\u003cimg src=\"https://img.shields.io/badge/Demo%20Site-Visit%20Now-brightgreen?style=for-the-badge\" alt=\"Demo site\"/\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\n\n\u003cp align=\"center\"\u003e\n  \u003cstrong\u003e\n    Soothing pastel theme for MkDocs based on the Catppuccin color palette\n  \u003c/strong\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://pypi.org/project/mkdocs-catppuccin\"\u003e\n    \u003cimg alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/mkdocs-catppuccin\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://pypi.org/project/mkdocs-catppuccin\"\u003e\n    \u003cimg alt=\"PyPI - Python Version\" src=\"https://img.shields.io/pypi/pyversions/mkdocs-catppuccin\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/ruslanlap/Catppuccin-MkDocs/blob/main/LICENSE\"\u003e\n    \u003cimg alt=\"License\" src=\"https://img.shields.io/github/license/ruslanlap/Catppuccin-MkDocs\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n---\n\n## 📖 Overview\n\nThis is a [MkDocs](https://www.mkdocs.org/) theme that extends [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) with the beautiful [Catppuccin](https://catppuccin.com) color palette. It provides a comfortable and aesthetically pleasing documentation experience with carefully crafted soothing pastel colors.\n\n## ✨ Features\n\n- 🎨 **Four Catppuccin Flavors**: Latte (light), Frappé, Macchiato, and Mocha (dark)\n- 🌈 **Complete Color Integration**: All UI elements styled with Catppuccin colors\n- 🎯 **Syntax Highlighting**: Code blocks with Catppuccin-themed syntax colors\n- 📱 **Fully Responsive**: Works perfectly on all devices\n- 🔌 **Easy Installation**: Just `pip install mkdocs-catppuccin`\n- ⚡ **Extends Material**: All Material for MkDocs features available\n\n## 🚀 Installation\n\nInstall the theme using pip:\n\n```bash\npip install mkdocs-catppuccin\n```\n\nOr install from source:\n\n```bash\ngit clone https://github.com/ruslanlap/Catppuccin-MkDocs.git\ncd Catppuccin-MkDocs\npip install -e .\n```\n\n## 📝 Step-by-Step Configuration Guide\n\n### Step 1: Install the Theme\n\n```bash\npip install mkdocs-catppuccin\n```\n\n### Step 2: Create Project Structure\n\nYour MkDocs project should have this structure:\n\n```\nyour-project/\n├── docs/\n│   ├── index.md              # Home page\n│   ├── assets/               # Assets folder (optional)\n│   │   └── logo.png         # Your logo\n│   └── stylesheets/         # CSS folder (optional)\n│       └── extra.css        # Your custom styles\n└── mkdocs.yml               # Configuration file\n```\n\n### Step 3: Basic Configuration\n\nCreate or edit your `mkdocs.yml` file:\n\n```yaml\n# Basic site information\nsite_name: Your Project Name\nsite_description: Your documentation description\nsite_url: https://yourname.github.io/your-project/\n\n# Catppuccin theme configuration\ntheme:\n  name: catppuccin\n  \n  # Choose color scheme (pick one or multiple)\n  palette:\n    # Light theme - Catppuccin Latte\n    - scheme: latte\n      toggle:\n        icon: material/weather-sunny\n        name: Switch to dark mode\n    \n    # Dark theme - Catppuccin Mocha\n    - scheme: mocha\n      toggle:\n        icon: material/weather-night\n        name: Switch to light mode\n  \n  # Add your logo (optional)\n  logo: assets/logo.png        # Path to your logo\n  favicon: assets/logo.png     # Browser tab icon\n  \n  # Useful features\n  features:\n    - navigation.tabs          # Navigation tabs\n    - navigation.sections      # Navigation sections\n    - navigation.top           # Back to top button\n    - search.suggest           # Search suggestions\n    - search.highlight         # Highlight search results\n    - content.code.copy        # Copy code button\n\n# Your site navigation\nnav:\n  - Home: index.md\n  - About: about.md\n\n# Plugins\nplugins:\n  - search                     # Documentation search\n```\n\n### Step 4: Custom Styles (Optional)\n\n**IMPORTANT:** The theme already includes all Catppuccin styles! You **DO NOT need** to add `extra_css` for basic usage.\n\nAdd `extra_css` **ONLY if** you want to customize something:\n\n```yaml\n# Add this ONLY if you need custom styles\nextra_css:\n  - stylesheets/extra.css      # Your custom styles\n```\n\nCreate `docs/stylesheets/extra.css` file for your customizations:\n\n```css\n/* Example: change heading color */\n.md-typeset h1 {\n  color: #c6a0f6;  /* Catppuccin Mauve */\n}\n```\n\n#### 🎨 Changing Accent Color (New Simplified Method!)\n\nThe theme uses **Green** as the default accent color for all flavors. You can now change the accent color for **all themes in just one place**!\n\n**Super Easy Method** (Recommended):\n\n1. Open `docs/stylesheets/catppuccin.css`\n2. Find the **ACCENT COLOR CONFIGURATION** section at the top (lines 5-18)\n3. Change `green` to any color you want in just **4 lines**!\n\n**Example - Change from Green to Pink:**\n\n```css\n/* ========================================\n   ACCENT COLOR CONFIGURATION\n   Change these to modify the accent color for all themes in one place!\n   Available colors: green, pink, blue, mauve, lavender, sky, teal, etc.\n   ======================================== */\n:root {\n    /* Change these 4 lines to switch accent colors for all themes */\n    --accent-latte: var(--ctp-latte-pink);\n    /* Default: green, Try: var(--ctp-latte-pink) */\n    --accent-frappe: var(--ctp-frappe-pink);\n    /* Default: green, Try: var(--ctp-frappe-pink) */\n    --accent-macchiato: var(--ctp-macchiato-pink);\n    /* Default: green, Try: var(--ctp-macchiato-pink) */\n    --accent-mocha: var(--ctp-mocha-pink);\n    /* Default: green, Try: var(--ctp-mocha-pink) */\n}\n```\n\n**Available Catppuccin colors:**\n`pink`, `mauve`, `blue`, `sapphire`, `sky`, `teal`, `green`, `yellow`, `peach`, `red`, `maroon`, `lavender`, `flamingo`, `rosewater`\n\n**What gets changed:**\n- ✅ Link colors\n- ✅ Navigation active states  \n- ✅ Hover effects\n- ✅ Code syntax highlighting (strings)\n- ✅ Success admonitions\n- ✅ Scrollbar hover\n- ✅ Table of contents active items\n\n### Step 5: All 4 Color Schemes\n\nIf you want to give users a choice of all 4 Catppuccin variants:\n\n```yaml\ntheme:\n  name: catppuccin\n  palette:\n    # Light theme - Latte\n    - scheme: latte\n      toggle:\n        icon: material/weather-sunny\n        name: Switch to Frappé\n    \n    # Dark theme - Frappé (coolest)\n    - scheme: frappe\n      toggle:\n        icon: material/weather-night\n        name: Switch to Macchiato\n    \n    # Dark theme - Macchiato (warm)\n    - scheme: macchiato\n      toggle:\n        icon: material/weather-partly-cloudy\n        name: Switch to Mocha\n    \n    # Dark theme - Mocha (warmest)\n    - scheme: mocha\n      toggle:\n        icon: material/weather-cloudy\n        name: Switch to Latte\n```\n\n### Step 6: Complete Configuration Example\n\nHere's a complete `mkdocs.yml` example with all features:\n\n```yaml\nsite_name: My Documentation\nsite_description: Beautiful documentation with Catppuccin theme\nsite_url: https://yourname.github.io/your-project/\nrepo_url: https://github.com/yourname/your-project\nrepo_name: yourname/your-project\n\ntheme:\n  name: catppuccin\n  palette:\n    - scheme: latte\n      toggle:\n        icon: material/weather-sunny\n        name: Switch to Frappé\n    - scheme: frappe\n      toggle:\n        icon: material/weather-night\n        name: Switch to Macchiato\n    - scheme: macchiato\n      toggle:\n        icon: material/weather-partly-cloudy\n        name: Switch to Mocha\n    - scheme: mocha\n      toggle:\n        icon: material/weather-cloudy\n        name: Switch to Latte\n  \n  logo: assets/logo.png\n  favicon: assets/logo.png\n  \n  features:\n    - navigation.tabs\n    - navigation.sections\n    - navigation.expand\n    - navigation.footer\n    - navigation.top\n    - navigation.tracking\n    - search.suggest\n    - search.highlight\n    - search.share\n    - content.code.copy\n    - content.code.annotate\n\n# Navigation\nnav:\n  - Home: index.md\n  - Configuration: configuration.md\n\n# Plugins\nplugins:\n  - search\n\n# Markdown extensions\nmarkdown_extensions:\n  - admonition\n  - pymdownx.details\n  - pymdownx.superfences\n  - pymdownx.highlight:\n      anchor_linenums: true\n  - pymdownx.inlinehilite\n  - pymdownx.snippets\n  - tables\n  - toc:\n      permalink: true\n\n# Copyright\ncopyright: Copyright \u0026copy; 2025 Your Name\n\n# Additional settings\nextra:\n  social:\n    - icon: fontawesome/brands/github\n      link: https://github.com/yourname/your-project\n  generator: false\n```\n\n### 📌 Important Notes\n\n1. **Logo**: Place your `logo.png` file in the `docs/assets/` folder\n2. **CSS**: The theme already includes all Catppuccin styles - `extra_css` is only needed for your own customizations\n3. **Color schemes**: You can use a single scheme or all four with a toggle\n4. **Testing**: Run `mkdocs serve` to preview your documentation locally\n\n## 🎨 Color Schemes\n\n### Light Mode - Latte 🌻\nPerfect for daytime reading with warm, gentle tones:\n- **Background**: `#eff1f5` (Base)\n- **Text**: `#4c4f69` (Text)\n- **Primary**: `#8839ef` (Mauve)\n- **Accent**: `#1e66f5` (Blue)\n\n### Dark Mode - Mocha 🌙\nCozy and comfortable for nighttime with rich, soft colors:\n- **Background**: `#1e1e2e` (Base)\n- **Text**: `#cdd6f4` (Text)\n- **Primary**: `#cba6f7` (Mauve)\n- **Accent**: `#89b4fa` (Blue)\n\n### Syntax Highlighting\n\nBoth themes include complete syntax highlighting:\n- **Keywords**: Red\n- **Strings**: Green\n- **Functions**: Mauve\n- **Numbers**: Peach\n- **Comments**: Overlay0\n- **Operators**: Sky\n- **Variables**: Rosewater\n\n## 📦 What's Included\n\n```\nmkdocs-catppuccin/\n├── mkdocs_catppuccin/\n│   ├── __init__.py\n│   ├── mkdocs_theme.yml         # Theme configuration\n│   └── assets/\n│       └── stylesheets/\n│           └── catppuccin.css   # Catppuccin colors\n├── pyproject.toml               # Package configuration\n├── LICENSE                      # MIT License\n└── README.md                    # This file\n```\n\n## 🔧 Development\n\n### Setting Up Development Environment\n\n```bash\n# Clone the repository\ngit clone https://github.com/ruslanlap/Catppuccin-MkDocs.git\ncd Catppuccin-MkDocs\n\n# Install in editable mode\npip install -e .\n\n# Create a test MkDocs project\nmkdocs new test-site\ncd test-site\n\n# Configure to use the theme\necho \"theme:\n  name: catppuccin\" \u003e mkdocs.yml\n\n# Serve the documentation\nmkdocs serve\n```\n\n### Building the Package\n\n```bash\n# Install build tools\npip install build twine\n\n# Build the package\npython -m build\n\n# The package will be in dist/\n```\n\n### Publishing to PyPI\n\n```bash\n# Upload to TestPyPI first\npython -m twine upload --repository testpypi dist/*\n\n# If everything looks good, upload to PyPI\npython -m twine upload dist/*\n```\n\n## 🤝 Contributing\n\nContributions are welcome! Feel free to:\n- Report bugs\n- Suggest new features\n- Submit pull requests\n- Improve documentation\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## 🙏 Credits\n\n- **Catppuccin Theme**: [catppuccin.com](https://catppuccin.com) - The beautiful color palette\n- **Material for MkDocs**: [squidfunk/mkdocs-material](https://github.com/squidfunk/mkdocs-material) - The base theme\n- **MkDocs**: [mkdocs.org](https://www.mkdocs.org/) - The documentation framework\n\n## 🔗 Links\n\n- **Homepage**: [github.com/ruslanlap/Catppuccin-MkDocs](https://github.com/ruslanlap/Catppuccin-MkDocs)\n- **PyPI**: [pypi.org/project/mkdocs-catppuccin](https://pypi.org/project/mkdocs-catppuccin)\n- **Catppuccin**: [catppuccin.com](https://catppuccin.com)\n- **Material for MkDocs**: [squidfunk.github.io/mkdocs-material](https://squidfunk.github.io/mkdocs-material)\n\n\n# Catppuccin-MkDocs\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruslanlap%2Fcatppuccin-mkdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fruslanlap%2Fcatppuccin-mkdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruslanlap%2Fcatppuccin-mkdocs/lists"}