{"id":15941636,"url":"https://github.com/codesue/walt","last_synced_at":"2025-08-16T14:32:06.844Z","repository":{"id":171407571,"uuid":"646985805","full_name":"codesue/walt","owner":"codesue","description":"🍃 A minimal documentation theme","archived":false,"fork":false,"pushed_at":"2023-12-19T22:48:41.000Z","size":1366,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-09T18:52:34.225Z","etag":null,"topics":["catppuccin","documentation-site","mkdocs-theme","writ"],"latest_commit_sha":null,"homepage":"https://codesue.github.io/walt/","language":"HTML","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/codesue.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}},"created_at":"2023-05-29T20:00:55.000Z","updated_at":"2024-11-06T18:53:08.000Z","dependencies_parsed_at":null,"dependency_job_id":"875f3d19-f593-441a-a116-647071eda863","html_url":"https://github.com/codesue/walt","commit_stats":null,"previous_names":["codesue/walt"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/codesue/walt","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codesue%2Fwalt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codesue%2Fwalt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codesue%2Fwalt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codesue%2Fwalt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codesue","download_url":"https://codeload.github.com/codesue/walt/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codesue%2Fwalt/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269818793,"owners_count":24480072,"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","status":"online","status_checked_at":"2025-08-10T02:00:08.965Z","response_time":71,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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","documentation-site","mkdocs-theme","writ"],"created_at":"2024-10-07T07:20:23.703Z","updated_at":"2025-08-16T14:32:06.521Z","avatar_url":"https://github.com/codesue.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# walt\n\n[![License][license_badge]][license_link]\n[![npm][npm_badge]][npm_link]\n[![PyPI][pypi_badge]][pypi_link]\n[![Repo Size][repo_size_badge]][repo_size_link]\n[![Docs][docs_badge]][docs_link]\n\nWalt is a minimal documentation theme based on [writ.css](https://writ.cmcenroe.me).\nIt features classless styles for semantic HTML and supports light and dark mode\nbased on system settings.\n\n\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"assets/images/mkdocs-walt-dark.png\" /\u003e\n  \u003cimg src=\"assets/images/mkdocs-walt-light.png\" alt=\"Screenshot of the Walt website\" /\u003e\n\u003c/picture\u003e\n\n## Stylesheet\n\nYou can include the Walt stylesheet in your project in the following ways:\n\n- Copy the stylesheet from GitHub:\n\n  https://github.com/codesue/walt/blob/main/walt.css\n\n- Install from npm:\n\n  ```sh\n  npm install --save walt.css\n  ```\n\n- Link to a CDN:\n\n  ```html\n  \u003clink rel=\"stylesheet\" href=\"https://unpkg.com/walt.css/walt.css\" /\u003e\n  ```\n\n### Code syntax highlighting\n\nFor code syntax highlighting in Walt, I recommend using [highlight.js](https://github.com/highlightjs/highlight.js) with [Catppuccin palettes](https://github.com/catppuccin/highlightjs).\nUse Macchiato for the dark color scheme and Latte for the light color scheme.\nFor example, you may add the following to your HTML files:\n\n```html\n\u003clink rel=\"stylesheet\" href=\"//unpkg.com/@catppuccin/highlightjs/css/catppuccin-macchiato.css\" media=\"(prefers-color-scheme: dark)\"\u003e\n\u003clink rel=\"stylesheet\" href=\"//unpkg.com/@catppuccin/highlightjs/css/catppuccin-latte.css\" media=\"(prefers-color-scheme: light)\"\u003e\n```\n\nIn a stylesheet or style tag, unset the background in code blocks styled by\nhighlight.js to maintain uniform background colors in code blocks and inline code:\n\n```css\n.hljs,\ncode.hljs {\n  background: unset;\n}\n```\n\nYou may also want to update the text color of comments if they no longer have enough\ncontrast with their backgrounds:\n\n```css\ncode .hljs-comment {\n  color: var(--color-secondary-text);\n}\n```\n## MkDocs theme\n\nWalt is available as an MkDocs theme that features:\n\n- classless styles for semantic HTML based on [writ.css](https://writ.cmcenroe.me)\n- light mode and dark mode based on system settings\n- an emoji favicon for browsers that support svg site icons\n- code syntax highlighting using highlight.js\n\nYou can install it from PyPI using:\n\n```sh\npip install mkdocs-walt\n```\n\nSee the [`mkdocs`](https://github.com/codesue/walt/blob/main/mkdocs)\ndirectory to learn how to install and use Walt in your MkDocs projects.\n\n## Contributing\n\nComing soon!\n\n## License\n\nCopyright \u0026copy; 2023 [Suzen Fylke](https://suzenfylke.com). Distributed under the MIT License.\n\n## Acknowledgements\n\nWalt uses [writ.css](https://github.com/programble/writ/) for styles\nand examples use [writ's reference html page](https://github.com/programble/writ/blob/master/reference.html).\n\nWalt also uses [Catppuccin](https://github.com/catppuccin/catppuccin) for code\nblock syntax highlighting and dark mode color palettes.\n\n[docs_badge]: https://img.shields.io/github/actions/workflow/status/codesue/walt/publish-docs.yml?label=docs\u0026colorA=363a4f\u0026colorB=b7bdf8\u0026style=flat\n[docs_link]: https://github.com/codesue/walt/actions/workflows/publish-docs.yml\n\n[license_badge]: https://img.shields.io/github/license/codesue/walt?colorA=363a4f\u0026colorB=b7bdf8\u0026style=flat\n[license_link]: https://github.com/codesue/walt/tree/main/LICENSE\n\n[npm_badge]: https://img.shields.io/npm/v/walt.css?colorA=363a4f\u0026colorB=b7bdf8\u0026style=flat\n[npm_link]: https://www.npmjs.com/package/walt.css\n\n[pypi_badge]: https://img.shields.io/pypi/v/mkdocs-walt?colorA=363a4f\u0026colorB=b7bdf8\u0026style=flat\n[pypi_link]: https://pypi.org/project/mkdocs-walt\n\n[repo_size_badge]: https://img.shields.io/github/repo-size/codesue/walt?colorA=363a4f\u0026colorB=b7bdf8\u0026style=flat\n[repo_size_link]: https://github.com/codesue/walt\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodesue%2Fwalt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodesue%2Fwalt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodesue%2Fwalt/lists"}