0.1.0-5 • Published 2 years ago
@farnabaz/studio v0.1.0-5
Nuxt Studio
A new experience to build content-driven website with Nuxt.
Features
- 👌 Zero configuration to start, works with any Nuxt 3 project
- 🪄 Write your Content with our Notion-like editor, powered by Milkdown
- 🎨 Edit your Design tokens with generated forms
- ⚙️ Define your project options
- 🚀 Works both in development and production with live preview
Installation
yarn add --dev @nuxthq/studio
Then, register the module in your nuxt.config.ts
:
export default defineNuxtConfig({
modules: [
'@nuxthq/studio'
]
})
If you want latest updates, please use @nuxthq/studio-edge
in your package.json
:
{
"devDependencies": {
"@nuxthq/studio": "npm:@nuxthq/studio-edge@latest"
}
}
Usage
The module will expose the Studio UI in development on /_studio/
.
Development
In this directory:
- Run
yarn install
. - Copy
ui/.env.example
toui/.env
and adjust based on playground port. - When using VS Code, press
F5
to start the dev servers. Or to do it manually:- Run
yarn play
to start the playground, you can extends both content-wind or docus so far. - Run
yarn ui
on another terminal.
- Run
- Visit http://localhost:3100/_studio to start.
To develop the Nuxt Studio UI in your project, install @nuxthq/studio
on your project and run nuxi dev
in your project instead of yarn play
.
License
- Define license
Copyright (c) NuxtLabs