You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+55-27Lines changed: 55 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,75 +59,103 @@ Originally offered as a standalone premium platform at https://nuxt.studio, Stud
59
59
60
60
> **Note**: This alpha release provides both a Monaco code editor and a TipTap visual WYSIWYG editor for Markdown content. You can switch between them at any time.
61
61
62
-
### 1. Module Installation
62
+
### 1. Install
63
63
64
-
Install the module in your Nuxt application with one command:
64
+
Install the module in your Nuxt application:
65
65
66
66
```bash
67
67
npx nuxi module add nuxt-studio@alpha
68
68
```
69
69
70
-
Add it to your `nuxt.config` and configure your repository.
70
+
### 2. Configure
71
+
72
+
Add it to your `nuxt.config.ts` and configure your repository:
71
73
72
74
```ts
73
75
exportdefaultdefineNuxtConfig({
74
76
modules: [
75
77
'@nuxt/content',
76
78
'nuxt-studio'
77
79
],
80
+
78
81
studio: {
79
-
// Your configuration
82
+
// Studio admin route (default: '/_studio')
83
+
route: '/_studio',
84
+
85
+
// Git repository configuration (owner and repo are required)
80
86
repository: {
81
-
provider: 'github', // default: only GitHub supported currently
82
-
owner: 'your-username', // your GitHub owner
83
-
repo: 'your-repo', // your GitHub repository name
84
-
branch: 'main',
85
-
rootDir: ''// optional: location of your content app
87
+
provider: 'github', // 'github' or 'gitlab'
88
+
owner: 'your-username', // your GitHub/GitLab username or organization
89
+
repo: 'your-repo', // your repository name
90
+
branch: 'main', // the branch to commit to (default: main)
86
91
}
87
92
}
88
93
})
89
94
```
90
95
91
-
### 2. Create a GitHub OAuth App
96
+
### 3. Dev Mode
97
+
98
+
🚀 **That's all you need to enable Studio locally!**
99
+
100
+
Run your Nuxt app and navigate to `/_studio` to start editing. Any file changes will be synchronized in real time with the file system.
101
+
102
+
> **Note**: The publish system is only available in production mode. Use your classical workflow (IDE, CLI, GitHub Desktop...) to publish your changes locally.
103
+
104
+
### 4. Production Mode
105
+
106
+
To enable publishing directly from your production website, you need to configure OAuth authentication.
107
+
108
+
#### Create a GitHub OAuth App
92
109
93
110
1. Go to [GitHub Developer Settings](https://github.com/settings/developers)
0 commit comments