Skip to content

Commit 28378f6

Browse files
committed
docs: more sections
1 parent 0705412 commit 28378f6

File tree

1 file changed

+18
-20
lines changed

1 file changed

+18
-20
lines changed

README.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
<br>
3737
<br>
3838

39-
### Streamlined Directory and File Creation
39+
### Directory and File Creation
4040

4141
Effortlessly generate all essential directories and files for your Nuxt project right from within VSCode. Utilize the command palette or context menus to swiftly create Vue/TypeScript files, as well as special files like [`.nuxtignore`](https://nuxt.com/docs/guide/directory-structure/nuxtignore), [`.nuxtrc`](https://nuxt.com/docs/api/configuration/nuxt-config), and [`app.config.ts`](https://nuxt.com/docs/guide/directory-structure/app-config).
4242

@@ -84,8 +84,6 @@ Additionally, you can choose to automatically open the newly created file with:
8484
<br>
8585
<br>
8686

87-
Certainly! Here's a refined version of the section on IntelliSense and Auto Completion:
88-
8987
### IntelliSense and Auto Completion
9088

9189
Nuxtr VSCode offers robust IntelliSense capabilities tailored for Vue files. This includes dynamic path completion for [NuxtLinks](https://nuxt.com/docs/api/components/nuxt-link#internal-routing) within the pages directory, and seamless handling of media resources from the [public or static directories](https://nuxt.com/docs/guide/directory-structure/public), depending on your Nuxt version. Additionally, enjoy IntelliSense support for critical configuration files like [`.nuxtignore`](https://nuxt.com/docs/guide/directory-structure/nuxtignore) and [`.nuxtrc`](https://nuxt.com/docs/guide/directory-structure/nuxtrc), ensuring precise guidance and efficient coding.
@@ -103,49 +101,47 @@ You can enable/disable IntelliSense from the settings:
103101

104102
### Nuxi CLI Integration
105103

106-
The Nuxt CLI, also known as [Nuxi](https://github.com/nuxt/cli), stands as an indispensable tool in the arsenal of every Nuxt developer. Nuxtr seamlessly incorporates this powerful CLI, allowing you to execute Nuxi commands right from the command palette. Under the `Nuxtr: Run` prefix, you'll find a set of pre-defined most-used commands readily available. Additionally, you have the option to access the complete list of Nuxi commands through the `Nuxtr: Nuxi CLI` command.
104+
The Nuxt CLI, also known as [Nuxi](https://github.com/nuxt/cli), is an essential tool for every Nuxt developer. Seamlessly integrated into Nuxtr, it enables you to effortlessly execute Nuxi commands directly from the command palette. Under the `Nuxtr: Run` prefix, you'll discover a curated set of frequently used commands at your fingertips. Additionally, you can access the complete list of Nuxi commands through the `Nuxtr: Nuxi CLI` command.
107105

108-
While it's entirely sensible to employ the CLI directly from your terminal, Nuxtr's inclusion will enhance your DX working with multiple terminals. It provides a structured approach to your terminal environment, categorizing commands based on their scope. This not only streamlines your workflow but also simplifies the process of adding modules, eliminating the need to recall or search for exact names.
106+
While using the CLI directly from your terminal is perfectly viable, Nuxtr's integration enhances your development experience, especially when working with multiple terminals. It introduces a structured approach to your terminal environment, categorizing commands based on their scope. This not only streamlines your workflow but also simplifies the process of adding modules, eliminating the need to recall or search for exact names.
109107

110108

111109
<br>
112110
<br>
113111

114-
### Nuxt/Custom Snippets
112+
### Nuxt, Nitro and Custom Snippets
115113

116-
**Nuxt Snippets**: You can use Nuxt snippets by typing `nuxt` for components, `use` for Composables or just start typing Nuxt utils and selecting your snippet from the list.
114+
**Nuxt Snippets**: Enhance your development speed with Nuxt snippets. Simply type `nuxt` for components, `use` for Composables, or begin typing Nuxt utilities and select your desired snippet from the list.
117115

118-
Nuxt Snippets is enabled by default. You can enable/disable them using this setting.
116+
Nuxt Snippets are enabled by default. You can toggle them on or off using this setting:
119117

120118
```JSON
121119
"nuxtr.snippets.nuxt": true
122120
```
123121

124-
**Nitro Snippets**: Nitro is empoweing Nuxt Server Engine. Please, refer to [Nitro Docs](https://nitro.unjs.io) for more information.
122+
**Nitro Snippets**: Nitro powers the Nuxt Server Engine. For detailed information, refer to the [Nitro Docs](https://nitro.unjs.io).
125123

126-
Nitro Snippets is enabled by default. You can enable/disable them using this setting.
124+
Nitro Snippets are enabled by default. You can customize their behavior using this setting:
127125

128126
```JSON
129127
"nuxtr.snippets.nitro": true
130128
```
131129

132-
**Custom Snippets**: Easily manage your custom snippets from the sidebar. You can create, edit or delete your snippets.
133-
134-
More on this side of the extension is coming soon!
130+
**Custom Snippets**: Easily manage your custom snippets directly from the sidebar. Create, edit, or delete your snippets with ease. Stay tuned for more updates on this feature!
135131

136132
![Snippets](./.github/media/snippets.gif)
137133

138134

139135
<br>
140136
<br>
141137

142-
### Vue File Templates
138+
### Personalized Vue File Templates
143139

144-
To provide users with greater flexibility in customizing their Vue files, we offer the ability to create and utilize personalized templates. These templates can be set as defaults or used selectively as per the user's preference.
140+
In order to offer users greater flexibility in tailoring their Vue files, we provide the capability to create and utilize personalized templates. These templates can be set as defaults or used selectively based on the user's preference.
145141

146-
We currently support two types of templates for ensuring a consistent user experience: `.page-template` and `.layout-template`. When Nuxt is loaded, these files are treated as regular Vue files, simplifying the editing process. Templates creation can be done from existing respective files via context menu item or empty templates from sidebar.
142+
We currently support two types of templates to ensure a consistent user experience: `.page-template` and `.layout-template`. When Nuxt is loaded, these files are treated as regular Vue files, simplifying the editing process. Templates can be created from existing respective files via the context menu or from empty templates accessed in the sidebar.
147143

148-
You can set your default template from these settings:
144+
Set your default template with these settings:
149145

150146
```JSON
151147
"nuxtr.vueFiles.pages.defaultTemplate": "default.page-template",
@@ -157,16 +153,18 @@ You can set your default template from these settings:
157153
<br>
158154
<br>
159155

160-
### srcDir, serverDir and monorepo support
156+
### Support for `srcDir`, `serverDir`, and Monorepo Projects
157+
158+
Nuxtr seamlessly integrates with projects using `srcDir` and `serverDir`, as well as monorepo setups. Set your `srcDir` or `serverDir` directly from your `nuxt.config.ts` file, and Nuxtr will detect and generate files/directories in the correct locations for you.
161159

162-
Nuxtr supports `srcDir`, `serverDir` and monorepo projects. You can set your `srcDir` from your `nuxt.config.ts` file and Nuxtr will create files/directories in the right place for you.
160+
Example:
163161

164162
```JSON
165163
"srcDir": "src",
166164
"serverDir": "server"
167165
```
168166

169-
Or locate your nuxt project in your monorepo using this setting in `.vscode/settings.json`:
167+
For monorepo configurations, specify the directory name containing your Nuxt project in your `.vscode/settings.json`:
170168

171169
```JSON
172170
"nuxtr.monorepoMode.DirectoryName": "directory-name"

0 commit comments

Comments
 (0)