A minimal and beautiful Nuxt layer for documentation websites
This is the official Nuxt layer for Docus, providing a complete documentation theming. It works with the Docus CLI for rapid project setup.
npm install docus
The easiest way to get started is using the Docus CLI, which automatically sets up a project with this layer:
# Create a new documentation project
npx create-docus my-docs
# Navigate to your project
cd my-docs
# Start development
npm run dev
This creates a complete documentation project pre-configured with docus.
For multi-language documentation, use the i18n template:
# Create a new i18n documentation project
npx create-docus my-docs -t i18n
Add the layer to your nuxt.config.ts:
export default defineNuxtConfig({
extends: ['docus']
})
For internationalization, also add the @nuxtjs/i18n module:
export default defineNuxtConfig({
modules: ['@nuxtjs/i18n'],
i18n: {
defaultLocale: 'en',
locales: [
{ code: 'en', name: 'English' },
{ code: 'fr', name: 'Français' },
],
}
})
Use directly with Nuxt CLI:
# Development
nuxt dev --extends docus
# Build
nuxt build --extends docus
create-docus - CLI tool to scaffold Docus projectsContributions are welcome! Please feel free to submit a Pull Request.
Made with ❤️ for the Nuxt community
FAQs
Nuxt layer for Docus documentation theme
We found that docus demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
An emerging npm supply chain attack that infects repos, steals CI secrets, and targets developer AI toolchains for further compromise.
Company News
Socket is proud to join the OpenJS Foundation as a Silver Member, deepening our commitment to the long-term health and security of the JavaScript ecosystem.
Security News
npm now links to Socket's security analysis on every package page. Here's what you'll find when you click through.