{"id":16696595,"url":"https://github.com/nicozweifel/vike-docs-template","last_synced_at":"2025-09-01T03:34:24.406Z","repository":{"id":216921074,"uuid":"740428983","full_name":"NicoZweifel/vike-docs-template","owner":"NicoZweifel","description":"A template for easily deploying customizable mdx pages.","archived":false,"fork":false,"pushed_at":"2024-03-03T16:28:06.000Z","size":414,"stargazers_count":9,"open_issues_count":4,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-23T23:16:30.884Z","etag":null,"topics":["documentation","esbuild","mdx","mdx-bundler","mdx-butler","preact","ssg","static-site-generation","template","vike"],"latest_commit_sha":null,"homepage":"https://vike-docs-template.nicozweifel.com/","language":"TypeScript","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/NicoZweifel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing/development.mdx","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":"2024-01-08T10:27:21.000Z","updated_at":"2025-02-26T19:03:24.000Z","dependencies_parsed_at":"2024-02-01T05:26:56.025Z","dependency_job_id":"ba043700-eb06-4567-8205-ffcce107605b","html_url":"https://github.com/NicoZweifel/vike-docs-template","commit_stats":null,"previous_names":["nicozweifel/vike-docs-template"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/NicoZweifel/vike-docs-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NicoZweifel%2Fvike-docs-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NicoZweifel%2Fvike-docs-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NicoZweifel%2Fvike-docs-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NicoZweifel%2Fvike-docs-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NicoZweifel","download_url":"https://codeload.github.com/NicoZweifel/vike-docs-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NicoZweifel%2Fvike-docs-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273069715,"owners_count":25040103,"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-09-01T02:00:09.058Z","response_time":120,"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":["documentation","esbuild","mdx","mdx-bundler","mdx-butler","preact","ssg","static-site-generation","template","vike"],"created_at":"2024-10-12T17:44:15.012Z","updated_at":"2025-09-01T03:34:24.382Z","avatar_url":"https://github.com/NicoZweifel.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vike-docs-template\n\n[![Docs](https://img.shields.io/badge/docs-online-green)](https://vike-docs-template.nicozweifel.com/)\n\nA simple template to easily deploy [`MDX`](https://mdxjs.com/) files.\n\n## Getting started\n\n- Clone the repository or create a repository from the template.\n- `pnpm i`\n- `pnpm dev`\n\n## Notes\n\n- Uses [`mdx-butler`](https://mdx-butler.com)\n- Author mdx files in a `docs` folder or with [any file pattern](https://vike-docs-template.nicozweifel.com/configuration#options).\n- File and frontmatter based routing\n- A Perfect lighthouse score.\n- Support for [`MDX`](https://mdxjs.com/) syntax in descriptions, table of contents, headings and more.\n- 100% static output, resulting in an easy and blazingly fast [Deployment](https://vike-docs-template.nicozweifel.com/deploy) to [`GitHub Pages`](https://pages.github.com/), [`Cloudflare Pages`](https://pages.cloudflare.com/), [`Netlify`](https://www.netlify.com/), [`AWS`](https://aws.amazon.com/) and many [other hosting providers](https://vike.dev/github-pages).\n- Full support for custom components and snippets. Import anything in your documents, all files will be bundled in parallel with [`mdx-bundler`](https://github.com/kentcdodds/mdx-bundler) and [`esbuild`](https://esbuild.github.io/).\n- Unopinionated styling. Easily add [Global CSS](https://vike-docs-template.nicozweifel.com/customization/UI/styling#global-css), a custom [`tailwind`](https://vike-docs-template.nicozweifel.com/customization/UI/styling#tailwind) config or other [styling solutions](https://vike-docs-template.nicozweifel.com/customization/UI/styling).\n- Fully Functional responsive layout and [`neutral`](https://tailwindcss.com/docs/customizing-colors) color styling out of the box.\n- No bloat - just the basics with a focus on only adding light-weight dependencies.\n- Easy to add analytics, search or other third party implementations.\n- Uses [`vike`](https://vike.dev/) + [`preact`](https://preactjs.com/) for a small client bundle size (~45kb zipped).\n- [`Unpic`](https://unpic.pics/) to handle Images.\n- [`prettier`](https://prettier.io/) and [`eslint`](https://eslint.org/) configuration for automatic linting and formatting of files, including [`MDX`](https://mdxjs.com/) documents and Code blocks.\n\n## Performance\n\n![Lighthouse results](/public/lighthouse.png)\n\n## Security Notice\n\n\u003e [!CAUTION]\n\u003e MDX is javascript. If not carefully done, evaluating user content can expose to XSS attacks.\n\u003e\n\u003e Always be careful if you are not evaluating your own content.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnicozweifel%2Fvike-docs-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnicozweifel%2Fvike-docs-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnicozweifel%2Fvike-docs-template/lists"}