gaetansenn / docus

Write beautiful documentations with Nuxt 3.

Docus

Docus is the fastest way to create document-driven websites with Vue & Markdown.

• 📄 Documentation
• ⚡️ Play on StackBlitz

Start a project with Docus

You can use this template to create a new project.

If you want to add Docus to an existing codebase, you can do so with:

• Install the dependency:

npm install @nuxt-themes/docus

• Add it to your extends key in nuxt.config:

defineNuxtConfig({
  extends: '@nuxt-themes/docus'
})

Features ✨

• +50 Components ready to build rich pages
• Article, Docs and Blog layouts
• Start from a README, scale to a framework documentation
• Table of contents support
• Configurable design system integration
• Replace, extend, customize any component in a breeze
• Leverages @nuxt-themes/typography
• Used on Content Documentation

They are using it 🎨

• nuxt/http
• nuxt/content
• nuxt/image
• nuxt-modules/tailwindcss
• nuxt-modules/strapi
• nuxt-modules/sanity
• nuxt-modules/i18n
• nuxt-modules/color-mode
• nuxt-modules/apollo
• nuxt-community/ackee-module
• hubble-exchange/docs
• sidebase
• haraka
• pinia-orm
• nuxt-typed-router
• Do you use Docus? Get listed here!

Contributing 🙏

1. Clone this repository
2. Install dependencies using yarn install or npm install
3. Run npm run prepare to generate type stubs.
4. Use npm run dev to start playground in development mode.

License 📎

MIT License