Nimiq VitePress Theme ​

A custom VitePress theme that brings the Nimiq brand to your documentation pages.

VitePress is a static site generator powered by Vite. The Nimiq VitePress theme extends it with a modern, multi-module documentation layout perfect for component libraries and design systems.

Features ​

• 🎨 Multi-Module Navigation - Organize docs into separate modules with independent sidebars
• 🌙 Dark Mode - Built-in light/dark theme support
• 📱 Responsive Design - Mobile-first layout that works everywhere
• 🔍 Local Search - Fast client-side search powered by VitePress
• 📋 Copy as Markdown - Export any page as markdown for LLMs and note-taking
• 🎯 Outline Actions - Customizable action buttons in the table of contents
• 🔗 Git Integration - Automatic changelog and source code links
• 🧩 Vue Components - Pre-built UI components for documentation

Quick Start ​

Install the theme:

pnpm add nimiq-vitepress-theme

npm install nimiq-vitepress-theme

Configure it in your VitePress project:

import { defineNimiqVitepressConfig } from 'nimiq-vitepress-theme'

export default defineNimiqVitepressConfig({
  title: 'My Docs',
  description: 'Documentation with Nimiq style',
  themeConfig: {
    modules: [],
    links: []
  }
})

See the Installation guide for complete setup instructions.

Example ​

This entire documentation site uses the Nimiq VitePress theme! Check the source code to see a real-world configuration.

Credits ​

• Layout inspired by Fumadocs
• Based on the Nimiq Hub documentation
• Icons from Tabler Icons and Nimiq Icons

Next Steps ​