{"id":30145329,"url":"https://github.com/grawl/uikit-docs-vuepress","last_synced_at":"2026-02-10T11:36:40.503Z","repository":{"id":47993513,"uuid":"196852189","full_name":"Grawl/uikit-docs-vuepress","owner":"Grawl","description":"UIkit documentation on VuePress","archived":false,"fork":false,"pushed_at":"2021-08-11T06:07:19.000Z","size":4658,"stargazers_count":2,"open_issues_count":15,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2024-04-15T14:20:35.576Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://uikit-docs-vuepress.surge.sh","language":null,"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/Grawl.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}},"created_at":"2019-07-14T15:21:57.000Z","updated_at":"2019-11-21T12:05:26.000Z","dependencies_parsed_at":"2022-08-12T16:10:22.296Z","dependency_job_id":null,"html_url":"https://github.com/Grawl/uikit-docs-vuepress","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Grawl/uikit-docs-vuepress","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Grawl%2Fuikit-docs-vuepress","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Grawl%2Fuikit-docs-vuepress/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Grawl%2Fuikit-docs-vuepress/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Grawl%2Fuikit-docs-vuepress/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Grawl","download_url":"https://codeload.github.com/Grawl/uikit-docs-vuepress/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Grawl%2Fuikit-docs-vuepress/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269850366,"owners_count":24485177,"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-11T02:00:10.019Z","response_time":75,"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":[],"created_at":"2025-08-11T08:12:24.103Z","updated_at":"2026-02-10T11:36:40.390Z","avatar_url":"https://github.com/Grawl.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# [UIkit](https://getuikit.com) documentation on [VuePress](https://vuepress.vuejs.org)\n\n\u003e UIkit is a large and good front-end framework and more than 50 components library.\n\n## Why rebuild UIkit documentation on VuePress\n\n[UIkit website repository](https://github.com/uikit/uikit-site) is broken: it's not possible to clone git repository and launch it on local machine.\n\nThere is an instruction in issue [uikit-site#152](https://github.com/uikit/uikit-site/issues/152) on how to build it.\n\nThis issue referenced in following issues:\n\n\u003e incorrect installation of the offline version [uikit-site#121](https://github.com/uikit/uikit-site/issues/121)\n\n\u003e uikit-site v3. how to install on owner local or virtual hosting? [uikit-site#119](https://github.com/uikit/uikit-site/issues/119)\n\n\u003e Can't install after last update [uikit-site#114](https://github.com/uikit/uikit-site/issues/114)\n\n\u003e can't install/update after last release [uikit-site#112](https://github.com/uikit/uikit-site/issues/112)\n\n\u003e How to install? [uikit-site#104](https://github.com/uikit/uikit-site/issues/104)\n\n\u003e Your website is not visibile for error [uikit-site#150](https://github.com/uikit/uikit-site/issues/150)\n\n\u003e Cannot Access Web [uikit-site#134](https://github.com/uikit/uikit-site/issues/134)\n\n\u003e I can't start local site [uikit-site#126](https://github.com/uikit/uikit-site/issues/126)\n\nSo, there is docs-only repository using [Vue CLI](https://cli.vuejs.org) to run UIkit documentation:\n\n- [Grawl/uikit-site-vue-cli](https://github.com/Grawl/uikit-site-vue-cli)\n\nFor software documentation, we want plain HTML files to put it into [Dash](https://kapeli.com/dash), [Zeal Docs](https://zealdocs.org) and other offline documentation software. But UIkit documentation repository [render MarkDown files on client browser](https://github.com/uikit/uikit-site/commit/2c8f6e01eeedd8fe354b70373650d4963a974435#diff-edc7164e7239b856a2e7161cd97035e2R85), without converting it into HTML on build process.\n\nSo, there is [`uikit-docs-vuepress`](https://github.com/Grawl/uikit-docs-vuepress) repository: VuePress created for rendering MarkDown files as HTML pages.\n\n## Benefits of using VuePress for UIkit documentation\n\n1. Render all documentation pages to HTML files\n2. VuePress search across documentation titles and page names\n3. Faster website updates\n\n    [`uikit/uikit-site`](https://github.com/uikit/uikit-site/issues) has a lot of open issues, plus some issues from [UIkit repository](https://github.com/uikit/uikit) about documentation and website. There is [a lot of Pull Requests](https://github.com/uikit/uikit-site/pulls) in UIkit website repository, some of them are older than a year\n\n## How this repository built\n\n`docs/` is copy of [`uikit/uikit-site/docs/pages/`](https://github.com/uikit/uikit-site/tree/develop/docs/pages)\n\n### Added UIkit support to Vuepress theme\n\n1. Ejexted VuePress theme with `vuepress eject`\n2. Added `require('uikit')` to `beforeMount()` of `docs/.vuepress/theme/layouts/Layout.vue`\n3. Added `\u003cstyle src=\"uikit/dist/css/uikit.css\"\u003e\u003c/style\u003e` to end of Layout\n\n### Destroyed UIkit code examples\n\nAs of UIkit code examples uses `example` language that uses `utils.js` extensions, we have to integrate this extensions into VuePress.\n\nSo, all `example` have replaced with `html` in all code blocks.\n\n## TODO\n\n- [ ] Replace version in `installation.md`\n- [ ] Integrate `utils.js` to make usage examples work\n- [ ] Pull [uikit-site#135](https://github.com/uikit/uikit-site/pull/135) Added Tests section\n- [x] Pull [uikit-site#113](https://github.com/uikit/uikit-site/pull/113) Organize components by function\n- [ ] Design theme to make it looks 1:1 as other UIkit pages?\n\n## Project setup\n\n```\nyarn install\n```\n\n### Compiles and hot-reloads for development\n\n```\nyarn run dev\n```\n\n### Compiles and minifies for production\n\n```\nyarn run build\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrawl%2Fuikit-docs-vuepress","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgrawl%2Fuikit-docs-vuepress","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrawl%2Fuikit-docs-vuepress/lists"}