Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nuxtlabs/studio-module
Edit Nuxt Content website with a visual editor, in produciton.
https://github.com/nuxtlabs/studio-module
markdown markdown-editor nuxt nuxt-content nuxt-module vue
Last synced: 10 days ago
JSON representation
Edit Nuxt Content website with a visual editor, in produciton.
- Host: GitHub
- URL: https://github.com/nuxtlabs/studio-module
- Owner: nuxtlabs
- License: mit
- Created: 2022-08-24T23:05:40.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T03:04:17.000Z (14 days ago)
- Last Synced: 2024-10-28T06:45:15.901Z (14 days ago)
- Topics: markdown, markdown-editor, nuxt, nuxt-content, nuxt-module, vue
- Language: TypeScript
- Homepage: https://nuxt.studio
- Size: 3.19 MB
- Stars: 107
- Watchers: 3
- Forks: 10
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Nuxt Studio Module
Official module of [Nuxt Studio](https://nuxt.studio).
Edit your websites made with [Nuxt Content](https://content.nuxt.com/), in production on any device.
📖 Official [Documentation](https://nuxt.studio/docs/get-started/setup)
## Features
- 🚀 Production [live preview](https://nuxt.studio/docs/projects/preview)
- ⌨️ Edit your [content](https://nuxt.studio/docs/developers/content)
- ⚙️ Update your [configs](https://nuxt.studio/docs/developers/app-config)
## Installation
Install the dependency to your project:
```bash
npx nuxi@latest module add studio
```
Then, register the module in your `nuxt.config.ts`:
```ts
export default defineNuxtConfig({
modules: [
'@nuxthq/studio'
]
})
```
## Configuration
Check out our setup [requirements](https://nuxt.studio/docs/projects/setup#requirements-to-use-the-studio-editor).
By default the Studio API is `https://api.nuxt.studio`. If you want to customise it, you can set the `STUDIO_API` environement variable.
```bash
# .env
STUDIO_API=http://localhost:{PORT}
```
## Nightly Builds
You can install the latest nightly build of the Studio module by running:
```bash
npx nuxi@latest module add studio
```
### Development
- Run `pnpm i` to install dependencies.
- Run `pnpm dev:prepare` to prepare the module in development mode.
- Run `pnpm dev` to start the dev server using [`playground/`](./playground/) as the project.
- Visit http://localhost:3000/
## License
[MIT License](./LICENSE)
Copyright (c) NuxtLabs
[npm-version-src]: https://img.shields.io/npm/v/@nuxthq/studio/latest.svg
[npm-version-href]: https://npmjs.com/package/@nuxthq/studio
[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxthq/studio.svg
[npm-downloads-href]: https://npmjs.com/package/@nuxthq/studio
[github-actions-ci-src]: https://github.com/nuxtlabs/studio/workflows/studio/badge.svg
[github-actions-ci-href]: https://github.com/nuxtlabs/studio/actions/workflows/studio.yml
[codecov-src]: https://img.shields.io/codecov/c/github/@nuxthq/studio.svg
[codecov-href]: https://codecov.io/gh/@nuxthq/studio
[license-src]: https://img.shields.io/npm/l/@nuxthq/studio.svg
[license-href]: https://npmjs.com/package/@nuxthq/studio