@matterlabs/docs-nuxt-template
v2.3.1
Published
[![License](https://img.shields.io/badge/license-MIT-blue)](LICENSE-MIT) [![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-orange)](LICENSE-APACHE) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4b
Downloads
634
Readme
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
Install Bun: Follow the installation instructions.
Install Dependencies:
bun install
Run Locally: Start the development server at
http://localhost:3000
.bun run dev
This will launch the test site from the .playground
directory.
🖥️ 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.
Contributing to the project
To learn more about how to contribute to this project, check out our Contributing doc.
📦 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']
]
})