Tragio / docus

Write beautiful documentations with Nuxt and Markdown.

Home Page:https://docus.dev

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Docus

Docus

npm version npm downloads License Nuxt Nuxt Studio Volta

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

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 🎨

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 docs or use pnpm run play to start playground in development mode.

License πŸ“Ž

MIT License

About

Write beautiful documentations with Nuxt and Markdown.

https://docus.dev

License:MIT License


Languages

Language:Vue 64.1%Language:TypeScript 32.7%Language:CSS 2.6%Language:JavaScript 0.6%