{"id":15388967,"url":"https://github.com/taocode/hugo-theme-windicss-starter","last_synced_at":"2025-04-15T20:23:15.272Z","repository":{"id":159322200,"uuid":"384771688","full_name":"taocode/hugo-theme-windicss-starter","owner":"taocode","description":"Lightning-Fast Hugo with UnoCSS (previously WindiCSS)","archived":false,"fork":false,"pushed_at":"2023-05-20T06:52:55.000Z","size":413,"stargazers_count":4,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-29T01:02:26.572Z","etag":null,"topics":["hugo","hugo-theme","starter-template","tailwindcss","theme-development","unocss","windicss"],"latest_commit_sha":null,"homepage":"https://hugo-theme-windicss-starter.netlify.app/","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/taocode.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":"2021-07-10T19:07:15.000Z","updated_at":"2024-03-28T03:42:42.000Z","dependencies_parsed_at":"2023-06-26T09:45:57.018Z","dependency_job_id":null,"html_url":"https://github.com/taocode/hugo-theme-windicss-starter","commit_stats":{"total_commits":105,"total_committers":6,"mean_commits":17.5,"dds":"0.37142857142857144","last_synced_commit":"e4bbd11b9f4ef434137fc5cefdd2bf742a323d3a"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taocode%2Fhugo-theme-windicss-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taocode%2Fhugo-theme-windicss-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taocode%2Fhugo-theme-windicss-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taocode%2Fhugo-theme-windicss-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/taocode","download_url":"https://codeload.github.com/taocode/hugo-theme-windicss-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249146078,"owners_count":21220078,"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":["hugo","hugo-theme","starter-template","tailwindcss","theme-development","unocss","windicss"],"created_at":"2024-10-01T14:58:43.135Z","updated_at":"2025-04-15T20:23:15.242Z","avatar_url":"https://github.com/taocode.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hugo Starter Theme with ~~Windi~~ **Uno**CSS\n\nStarter files for a Hugo theme with ~~Windi~~ **Uno**CSS.\n\n[![Netlify Status](https://api.netlify.com/api/v1/badges/e4a560ce-4be2-41f6-ba0c-9b9d3adcbef4/deploy-status)](https://app.netlify.com/sites/hugo-theme-windicss-starter/deploys)\n\n## [✨Example Site💨 🔗](https://hugo-theme-windicss-starter.netlify.app/)\n\n\n- set up to use [UnoCSS](https://unocss.dev/) the successor to [Windi CSS](https://windicss.org)\n- includes the [typography preset](https://unocss.dev/presets/typography) plugin for styling of markdown content (including dark mode friendly *.prose* color fixes)\n- use [UnoCSS CLI](https://unocss.dev/integrations/cli) integration *(@apply and @screen directives can be used via [Directive Transformer](https://unocss.dev/transformers/directives), consider using: [UnoCSS Shortcuts](https://unocss.dev/config/shortcuts))* to build optimized uno.css with used classes *(only)*, circumventing the need to purge.\n- works as separate theme repo or as a local theme folder within a Hugo site\n- exampleSite uses basic template setup with an index page, an about page and a posts category\n- dark mode toggle\n- responsive navigation header with ~~pure css~~ *minimal javascript* for 1) dark mode and 2) mobile \"hamburger\" nav on small screens; *the pure CSS solution to the hamburger menu fails keyboard accessibility.*\n- included helper partials to show Hugo parameters and UnoCSS breakpoints during development\n\n## What this theme is NOT\n\nThis theme is a starter setup theme to aid in developing Hugo themes using the UnoCSS framework. It is ***not*** a standalone theme ready to use.\n\n## Try before you buy\n\nStart a local server with `exampleSite` or [see the example site on Netlify](https://hugo-theme-windicss-starter.netlify.app/)\n\n```bash\ncd themes/unocss-starter/exampleSite\nnpm install\nnpm run example\n```\n\n## Prerequisites\n\nMake sure to install `unocss` as detailed in the [UnoCSS CLI Docs](https://unocss.dev/integrations/cli).\n\n```bash\nnpm install -g unocss\n```\n\nMake sure to use a minimum Hugo version of v0.69.0 and above.\n\n## Basic usage to develop a separate Theme repo\n\n- clone and rename the repo\n\n```bash\ngit clone https://github.com/taocode/hugo-theme-windicss-starter themes/unocss-starter\n```\n\n- to make that theme your own, switch into the newly created folder, remove the git history from this starter repo and initiate a new git repo\n\n```bash\ncd themes/unocss-starter\nrm -rf .git\ngit init\n```\n\n- copy `uno.config.ts`, `package.json` and optionally `config.toml` from `exampleSite` to your project root (`/`)\n\n- install the necessary node packages\n\n```bash\nnpm install\n```\n\n- edit the `config.toml` file in project root (`/`) or `exampleSite/` to reflect the `unocss-starter`\n\n```toml\n# in config.toml\ntheme = \"unocss-starter\" # your new theme name here\n```\n\n## Usage directly within a Hugo repo as a theme package\n\n- start a new Hugo site\n\n```bash\nhugo new site new-site\n```\n\n- switch into the theme folder an clone the starter repo\n\n```bash\ncd new-site\ngit clone https://github.com/taocode/hugo-theme-windicss-starter themes/unocss-starter\n```\n\n- switch into the newly created theme folder, remove the git history from this starter repo and install the node packages\n\n```bash\ncd themes/unocss-starter\nrm -rf .git\nnpm install\n```\n\n- edit the `config.toml` file in `new-site/` to reflect the unocss-starter\n\n```toml\n# in config.toml\ntheme = \"new-theme-name\" # your new theme name here\n```\n\n- switch to the root of the new-site repo and start a server to view the index site\n\n```bash\ncd new-site\nhugo server --disableFastRender\n```\n\nYour content should go into `new-site/content`, the development of the site layout is done within `new-site/themes/new-theme-name/layout`.\n\n## Developer Mode Helpers\n\nIncluded are the following helpers for the development phase (not visible in production):\n\n- `/partials/dev-parameters.html`, which shows basic Hugo page parameters\n- `/partials/dev-size-indicator.html`, which displays a floating circle in the upper right corner to indicate the UnoCSS responsive breakpoints\n\nIf you don't need any of these helpers anymore, just delete the corresponding line from `/layouts/_default/baseof.html`.\n\n## Deploy to Netlify\n\nIf you use this starter theme and want to deploy your site to [Netlify](https://www.netlify.com/), you *MAY* encounter a build error about unocss missing:\n\nNetlify will need to `npm install` dependencies of this starter. Please copy the `exampleSite/package.json` and `exampleSite/uno.config.ts` file to the root of your project:\n\n```json\ncp themes/unocss-starter/exampleSite/package.json ./\ncp themes/unocss-starter/exampleSite/uno.config.ts ./\n```\n\nThis introduces the dependencies UnoCSS needs, Netlify will run the installation automatically on deploy, use: `npm run build`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaocode%2Fhugo-theme-windicss-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftaocode%2Fhugo-theme-windicss-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaocode%2Fhugo-theme-windicss-starter/lists"}