https://github.com/nicozweifel/vike-docs-template

A template for easily deploying customizable mdx pages.
https://github.com/nicozweifel/vike-docs-template

documentation esbuild mdx mdx-bundler mdx-butler preact ssg static-site-generation template vike

Last synced: about 2 months ago
JSON representation

A template for easily deploying customizable mdx pages.

• Host: GitHub
• URL: https://github.com/nicozweifel/vike-docs-template
• Owner: NicoZweifel
• License: mit
• Created: 2024-01-08T10:27:21.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-03T16:28:06.000Z (about 1 year ago)
• Last Synced: 2025-04-02T00:32:55.844Z (about 2 months ago)
• Topics: documentation, esbuild, mdx, mdx-bundler, mdx-butler, preact, ssg, static-site-generation, template, vike
• Language: TypeScript
• Homepage: https://vike-docs-template.nicozweifel.com/
• Size: 404 KB
• Stars: 9
• Watchers: 1
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing/development.mdx
  • License: LICENSE

Awesome Lists containing this project

README

        
# vike-docs-template

[![Docs](https://img.shields.io/badge/docs-online-green)](https://vike-docs-template.nicozweifel.com/)

A simple template to easily deploy [`MDX`](https://mdxjs.com/) files.

## Getting started

- Clone the repository or create a repository from the template.

- `pnpm i`

- `pnpm dev`

## Notes

- Uses [`mdx-butler`](https://mdx-butler.com)

- Author mdx files in a `docs` folder or with [any file pattern](https://vike-docs-template.nicozweifel.com/configuration#options).

- File and frontmatter based routing

- A Perfect lighthouse score.

- Support for [`MDX`](https://mdxjs.com/) syntax in descriptions, table of contents, headings and more.

- 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).

- 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/).

- 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).

- Fully Functional responsive layout and [`neutral`](https://tailwindcss.com/docs/customizing-colors) color styling out of the box.

- No bloat - just the basics with a focus on only adding light-weight dependencies.

- Easy to add analytics, search or other third party implementations.

- Uses [`vike`](https://vike.dev/) + [`preact`](https://preactjs.com/) for a small client bundle size (~45kb zipped).

- [`Unpic`](https://unpic.pics/) to handle Images.

- [`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.

## Performance

![Lighthouse results](/public/lighthouse.png)

## Security Notice

> [!CAUTION]

> MDX is javascript. If not carefully done, evaluating user content can expose to XSS attacks.

>

> Always be careful if you are not evaluating your own content.