vike-docs-template

A simple template to easily deploy MDX files.

Getting started

• Clone the repository or create a repository from the template.
• pnpm i
• pnpm dev

Notes

• Uses mdx-butler
• Author mdx files in a docs folder or with any file pattern.
• File and frontmatter based routing
• A Perfect lighthouse score.
• Support for MDX syntax in descriptions, table of contents, headings and more.
• 100% static output, resulting in an easy and blazingly fast Deployment to GitHub Pages, Cloudflare Pages, Netlify, AWS and many other hosting providers.
• Full support for custom components and snippets. Import anything in your documents, all files will be bundled in parallel with mdx-bundler and esbuild.
• Unopinionated styling. Easily add Global CSS, a custom tailwind config or other styling solutions.
• Fully Functional responsive layout and neutral 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 + preact for a small client bundle size (~45kb zipped).
• Unpic to handle Images.
• prettier and eslint configuration for automatic linting and formatting of files, including MDX documents and Code blocks.

Performance

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.