{"id":13471081,"url":"https://github.com/catppuccin/mdBook","last_synced_at":"2025-03-26T13:30:46.943Z","repository":{"id":49306271,"uuid":"517220423","full_name":"catppuccin/mdBook","owner":"catppuccin","description":"🎊 Soothing pastel theme for mdBook","archived":false,"fork":false,"pushed_at":"2024-10-28T04:51:42.000Z","size":3505,"stargazers_count":144,"open_issues_count":5,"forks_count":6,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-10-30T02:58:20.525Z","etag":null,"topics":["catppuccin","hacktoberfest","markdown","mdbook","mdbook-preprocessor","mdbook-theme","theme"],"latest_commit_sha":null,"homepage":"http://mdbook.catppuccin.com","language":"Handlebars","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/catppuccin.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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},"funding":{"github":"catppuccin","open_collective":"catppuccin"}},"created_at":"2022-07-24T03:50:29.000Z","updated_at":"2024-10-28T11:31:50.000Z","dependencies_parsed_at":"2024-01-13T16:58:23.741Z","dependency_job_id":"140f8283-e559-4b41-8e32-fce4bcb36f15","html_url":"https://github.com/catppuccin/mdBook","commit_stats":{"total_commits":194,"total_committers":11,"mean_commits":"17.636363636363637","dds":0.3041237113402062,"last_synced_commit":"9b436bf09bec634bf797a0b363249c718b6fa332"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catppuccin%2FmdBook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catppuccin%2FmdBook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catppuccin%2FmdBook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catppuccin%2FmdBook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/catppuccin","download_url":"https://codeload.github.com/catppuccin/mdBook/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245662731,"owners_count":20652072,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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","hacktoberfest","markdown","mdbook","mdbook-preprocessor","mdbook-theme","theme"],"created_at":"2024-07-31T16:00:39.482Z","updated_at":"2025-03-26T13:30:46.928Z","avatar_url":"https://github.com/catppuccin.png","language":"Handlebars","funding_links":["https://github.com/sponsors/catppuccin","https://opencollective.com/catppuccin"],"categories":["Handlebars","CSS"],"sub_categories":[],"readme":"\u003ch3 align=\"center\"\u003e\n\t\u003cimg src=\"https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/logos/exports/1544x1544_circle.png\" width=\"100\" alt=\"Logo\"/\u003e\u003cbr/\u003e\n\t\u003cimg src=\"https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png\" height=\"30\" width=\"0px\"/\u003e\n\tCatppuccin for \u003ca href=\"https://rust-lang.github.io/mdBook/\"\u003emdBook\u003c/a\u003e\n\t\u003cimg src=\"https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png\" height=\"30\" width=\"0px\"/\u003e\n\u003c/h3\u003e\n\n\u003cp align=\"center\"\u003e\n\t\u003ca href=\"https://github.com/catppuccin/mdBook/stargazers\"\u003e\u003cimg src=\"https://img.shields.io/github/stars/catppuccin/mdBook?colorA=363a4f\u0026colorB=b7bdf8\u0026style=for-the-badge\"\u003e\u003c/a\u003e\n\t\u003ca href=\"https://github.com/catppuccin/mdBook/issues\"\u003e\u003cimg src=\"https://img.shields.io/github/issues/catppuccin/mdBook?colorA=363a4f\u0026colorB=f5a97f\u0026style=for-the-badge\"\u003e\u003c/a\u003e\n\t\u003ca href=\"https://github.com/catppuccin/mdBook/contributors\"\u003e\u003cimg src=\"https://img.shields.io/github/contributors/catppuccin/mdBook?colorA=363a4f\u0026colorB=a6da95\u0026style=for-the-badge\"\u003e\u003c/a\u003e\n\t\u003ca href=\"https://crates.io/crates/mdbook-catppuccin\"\u003e\u003cimg src=\"https://img.shields.io/crates/v/mdbook-catppuccin?colorA=363a4f\u0026colorB=ee99a0\u0026style=for-the-badge\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\t\u003cimg src=\"assets/catwalk.webp\"/\u003e\n\u003c/p\u003e\n\n## Previews\n\n\u003cdetails\u003e\n\u003csummary\u003e🌻 Latte\u003c/summary\u003e\n\u003cimg src=\"assets/latte.webp\"/\u003e\n\u003c/details\u003e\n\u003cdetails\u003e\n\u003csummary\u003e🪴 Frappé\u003c/summary\u003e\n\u003cimg src=\"assets/frappe.webp\"/\u003e\n\u003c/details\u003e\n\u003cdetails\u003e\n\u003csummary\u003e🌺 Macchiato\u003c/summary\u003e\n\u003cimg src=\"assets/macchiato.webp\"/\u003e\n\u003c/details\u003e\n\u003cdetails\u003e\n\u003csummary\u003e🌿 Mocha\u003c/summary\u003e\n\u003cimg src=\"assets/mocha.webp\"/\u003e\n\u003c/details\u003e\n\n## Usage\n\n\u003e [!IMPORTANT]  \n\u003e The `mdbook-catppuccin` rust package has been deprecated. For further information\n\u003e on why this decision was made, please refer to\n\u003e [catppuccin/mdBook#107](https://github.com/catppuccin/mdBook/issues/107)\n\u003e\n\u003e Please follow the instructions below to install the Catppuccin theme for mdBook.\n\n1. Initialise your mdBook with the theme files:\n\n   ```shell\n   mdbook init --theme \u003cname\u003e\n   ```\n\n2. Enter the book directory and remove all theme files except `index.hbs`:\n\n   ```shell\n   cd \u003cname\u003e\n   # Remove all files except index.hbs\n   find ./theme -type f ! -name 'index.hbs' -delete\n   # Remove the left over empty directories\n   rm -d fonts css\n   ```\n\n3. Download the [catppuccin.css](https://github.com/catppuccin/mdBook/releases/latest/download/catppuccin.css)\n   file from the [latest GitHub release](https://github.com/catppuccin/mdBook/releases/latest) to the `theme`\n   directory.\n\n   See the [Supported Plugins](#supported-plugins) section below for integrations with other\n   mdBook plugins.\n\n4. Update `additional-css` key within the `book.toml` as shown below\n\n   ```diff\n   [output.html]\n   -additional-css = []\n   +additional-css = [\"./theme/catppuccin.css\"]\n   ```\n\n5. Edit the `index.hbs` file to include the Catppuccin flavors:\n\n   ```diff\n   - \u003cli role=\"none\"\u003e\u003cbutton role=\"menuitem\" class=\"theme\" id=\"light\"\u003eLight\u003c/button\u003e\u003c/li\u003e\n   - \u003cli role=\"none\"\u003e\u003cbutton role=\"menuitem\" class=\"theme\" id=\"rust\"\u003eRust\u003c/button\u003e\u003c/li\u003e\n   - \u003cli role=\"none\"\u003e\u003cbutton role=\"menuitem\" class=\"theme\" id=\"coal\"\u003eCoal\u003c/button\u003e\u003c/li\u003e\n   - \u003cli role=\"none\"\u003e\u003cbutton role=\"menuitem\" class=\"theme\" id=\"navy\"\u003eNavy\u003c/button\u003e\u003c/li\u003e\n   - \u003cli role=\"none\"\u003e\u003cbutton role=\"menuitem\" class=\"theme\" id=\"ayu\"\u003eAyu\u003c/button\u003e\u003c/li\u003e\n   + \u003cli role=\"none\"\u003e\u003cbutton role=\"menuitem\" class=\"theme\" id=\"latte\"\u003eLatte\u003c/button\u003e\u003c/li\u003e\n   + \u003cli role=\"none\"\u003e\u003cbutton role=\"menuitem\" class=\"theme\" id=\"frappe\"\u003eFrappé\u003c/button\u003e\u003c/li\u003e\n   + \u003cli role=\"none\"\u003e\u003cbutton role=\"menuitem\" class=\"theme\" id=\"macchiato\"\u003eMacchiato\u003c/button\u003e\u003c/li\u003e\n   + \u003cli role=\"none\"\u003e\u003cbutton role=\"menuitem\" class=\"theme\" id=\"mocha\"\u003eMocha\u003c/button\u003e\u003c/li\u003e\n   ```\n\n   Additionally, you can use\n   [default-theme](https://rust-lang.github.io/mdBook/format/configuration/renderers.html?highlight=default-theme#html-renderer-options)\n   and\n   [preferred-dark-theme](https://rust-lang.github.io/mdBook/format/configuration/renderers.html?highlight=preferred-dark-theme#html-renderer-options)\n   keys for setting default light/dark mode themes in your `book.toml`.\n\n   E.g. To set the default theme to `latte` and default dark mode to `mocha`:\n\n   ```diff\n   [output.html]\n   + default-theme = \"latte\"\n   + preferred-dark-theme = \"mocha\"\n   ```\n\n6. Build using `mdbook build` and enjoy your new Catppuccin flavors!\n\n### Supported Plugins\n\nThis theme also generates CSS files to style elements added by other mdBook\nplugins. We support the following list of plugins:\n\n| Plugin                                                            | CSS File                                                                                                         |\n| ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |\n| [mdbook-admonish](https://github.com/tommilligan/mdbook-admonish) | [catppuccin-admonish.css](https://github.com/catppuccin/mdBook/releases/latest/download/catppuccin-admonish.css) |\n| [mdbook-alerts](https://github.com/lambdalisue/rs-mdbook-alerts)  | [catppuccin-alerts.css](https://github.com/catppuccin/mdBook/releases/latest/download/catppuccin-alerts.css)     |\n\nThe CSS file(s) can be downloaded and added to the `additional-css` key shown\nin step `4.` of the [Usage](#usage) section.\n\n## Development\n\n1. Clone the repository and navigate to the repository root.\n\n   ```shell\n   git clone https://github.com/catppuccin/mdbook\n   cd mdbook\n   ```\n\n2. Generate the CSS files:\n\n   ```shell\n   pnpm install\n   pnpm run build\n   ```\n\n## Acknowledgement\n\n[mdbook-admonish](https://github.com/tommilligan/mdbook-admonish) for\ninspiration on the `install` command for the now deprecated `mdbook-catppuccin`\nbinary.\n\n## 💝 Thanks to\n\n- [Hamothy](https://github.com/sgoudham)\n- [winston](https://github.com/nekowinston)\n\n\u0026#160;\n\n\u003cp align=\"center\"\u003e\n\t\u003cimg src=\"https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/footers/gray0_ctp_on_line.svg?sanitize=true\" /\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\tCopyright \u0026copy; 2021-present \u003ca href=\"https://github.com/catppuccin\" target=\"_blank\"\u003eCatppuccin Org\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\t\u003ca href=\"https://github.com/catppuccin/catppuccin/blob/main/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/static/v1.svg?style=for-the-badge\u0026label=License\u0026message=MIT\u0026logoColor=d9e0ee\u0026colorA=363a4f\u0026colorB=b7bdf8\"/\u003e\u003c/a\u003e\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcatppuccin%2FmdBook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcatppuccin%2FmdBook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcatppuccin%2FmdBook/lists"}