Docus

Write beautiful documentations with Nuxt and Markdown.

DocumentationVue
nuxt-themes/docusdocus.dev

README

Docus

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:

  1. ```bash
  2. npm install @nuxt-themes/docus
  3. ```

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

  1. ```ts
  2. defineNuxtConfig({
  3.   extends: '@nuxt-themes/docus'
  4. })
  5. ```

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](https://github.com/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 pnpm install --frozen-lockfile
3. Run pnpm run prepare to generate type stubs.
4. Use pnpm run dev to start default starter. You can edit the module because pnpm workspace links it with the default starter.
5. Do not commit any change in .starters/default since its your playground.

License 📎


MIT License

[npm-version-src]: https://img.shields.io/npm/v/@nuxt-themes/docus/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@nuxt-themes/docus

[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxt-themes/docus.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/@nuxt-themes/docus

[license-src]: https://img.shields.io/github/license/nuxt-themes/docus.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://github.com/nuxt-themes/docus/blob/main/LICENSE

[nuxt-studio-src]: https://img.shields.io/badge/Open%20in%20Nuxt%20Studio-18181B?&logo=nuxt.js&logoColor=3BB5EC
[nuxt-studio-href]: https://nuxt.studio/themes/docus

[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?&logo=nuxt.js
[nuxt-href]: https://nuxt.com

[volta-src]: https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg
[volta-href]: https://volta.net/nuxt-themes/docus?utm_source=readme_docus