@matterlabs/docs-nuxt-template

Docs Template

The docs-nuxt-template is a theme built as a Nuxt Layer to use for Developer Portal related apps. It contains the color scheme, general theming, components and common Nuxt Modules shared across apps.

🚀 Quick start

1. Install Bun: Follow the installation instructions.

2. Install Dependencies:

   bun install
   

3. Run Locally: Start the development server at http://localhost:3000.

   bun run dev
   

This will launch the test site from the .playground directory.

📘 Developer Docs

Notes for developers getting started in the project or who have questions about certain features and functionality can refer to the /docs directory. Notes are provided to help understand how to manage particular features that may require adjusting or setup for a developer's local environment to work smoothly.

🖥️ Developing locally

To test the theme during development, the .playground directory is available. Run bun run dev to start the playground site, which imports the theme itself.

Content built within the .playground are for testing purposes only and are not built as part of the template package.

📦 Using the theme in another project

This project is packaged and published to NPM under @matterlabs/docs-nuxt-template. Install the npm package with bun install @matterlabs/docs-nuxt-template.

Edit the nuxt.config.ts file of the child project and include this theme in the extends property.

defineNuxtConfig({
  extends: [
    ['@matterlabs/docs-nuxt-template']
  ]
})

🛠️ Built With

• Vue
• Nuxt
• Nuxt Content
• Nuxt UI & Nuxt UI Pro
• Tailwind
• Bun