Skip to content
/ docux Public

Write beautiful documentations with Nuxt and Markdown.

License

Notifications You must be signed in to change notification settings

nyxb/docux

Repository files navigation

Docux

Docux

npm version npm downloads License nyxb Nuxt Volta

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

Start a project with Docux

To get a local copy of the code, use nyxbi cli:

npx nyxbi init -t themes/docux my-app

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

  • Install the dependency:
npm install docux
  • Add it to your extends key in nuxt.config:
defineNuxtConfig({
  extends: 'docux'
})

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

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