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
@@ -14,46 +14,116 @@ This guide introduces **Syncfusion DOCX Editor SDK Skills**, a knowledge package
14
14
Syncfusion<supstyle="font-size:70%">®</sup> DOCX Editor SDK Skills eliminate common issues with generic AI suggestions by grounding the assistant in accurate Syncfusion<supstyle="font-size:70%">®</sup> DOCX Editor SDK library APIs, supported features, and platform-specific configuration for the following platforms:
Each platform's skill file includes component initialization, property configuration, event handling and common usage patterns specific to that framework.
Before installing Syncfusion<supstyle="font-size:70%">®</sup> DOCX Editor SDK Skills, ensure the following tools are available on your machine:
28
29
29
30
-**[Node.js](https://nodejs.org/en)** (v18 or later) — Required to run `npx` commands for installing skills.
31
+
- A supported AI agent or IDE that integrates with the Skills CLI (VS Code, Syncfusion® Code Studio, Cursor, etc.)
30
32
31
33
## Installation
32
34
33
-
Choose one of the following commands to install Syncfusion<supstyle="font-size:70%">®</sup> DOCX Editor SDK Skills based on your preference. Users can also explore Syncfusion<supstyle="font-size:70%">®</sup> skills from the [marketplace](https://skills.sh/syncfusion/).
35
+
Use one of the following commands to install [Syncfusion<supstyle="font-size:70%">®</sup> DOCX Editor SDK Skills](https://github.com/syncfusion/docx-editor-sdk-skills). You can also browse Syncfusion<supstyle="font-size:70%">®</sup> skills in the [marketplace](https://skills.sh/syncfusion/).
36
+
37
+
To install all DOCX Editor SDK skills at once, use the following command:
Choose and install skills interactively from the terminal:
58
+
59
+
{% tabs %}
60
+
{% highlight bash tabtitle="npm" %}
61
+
40
62
npx skills add syncfusion/docx-editor-sdk-skills
41
-
```
42
63
43
-
This registers the Syncfusion<supstyle="font-size:70%">®</sup> skill pack so your AI assistant can automatically load it in supported IDEs such as [Code Studio](https://help.syncfusion.com/code-studio/reference/configure-properties/skills), [Visual Studio Code](https://code.visualstudio.com/docs/copilot/customization/agent-skills), and [Cursor](https://cursor.com/docs/skills).
64
+
{% endhighlight %}
65
+
{% endtabs %}
44
66
45
-
To learn more about the Skills CLI, refer [here](https://skills.sh/docs).
67
+
The terminal will show a list of available skills. Use the arrow keys to navigate, space bar to select the skills you want, and Enter to confirm.
46
68
47
-
## What's Included
69
+
{% tabs %}
70
+
{% highlight bash tabtitle="npm" %}
48
71
49
-
1.**Docx Editor & API Knowledge** — Curated, skill-based guidance that captures how to create, edit, and manage Document Editing operations using Syncfusion<supstyle="font-size:70%">®</sup> platform-specific libraries (React, Angular, Blazor, ASP.NET Core, TypeScript, Vue), including key APIs, supported features, and common usage patterns.
50
-
2.**Platform-Specific Code Generation** — Each skill supports generating production-ready platform-specific code for your project. The assistant automatically detects the project type and provides code snippets that can be inserted directly into your application files (e.g., `Program.cs`, `Home.razor`, `app.ts`).
51
-
3.**Patterns & Best Practices** — Practical recommendations for API usage, platform-specific package selection, and spreadsheet editor workflows (for example, cell formatting, data binding, formula calculation, chart creation, and worksheet protection). All guidance is authored directly within the Skill file rather than being fetched from documentation.
72
+
Select skills to install (space to toggle)
73
+
│ ◻ syncfusion-react-docx-editor
74
+
│ ◻ syncfusion-angular-docx-editor
75
+
│ ◻ syncfusion-blazor-docx-editor
76
+
│ ◻ syncfusion-aspnetcore-docx-editor
77
+
│ ◻ syncfusion-uwp-docx-editor
78
+
│ ◻ syncfusion-wpf-docx-editor
79
+
│ .....
52
80
53
-
## How Syncfusion<supstyle="font-size:70%">®</sup> DOCX Editor SDK Agent Skills Work
81
+
{% endhighlight %}
82
+
{% endtabs %}
83
+
84
+
Next, select which AI agent you're using and where to store the skills.
85
+
{% tabs %}
86
+
{% highlight bash tabtitle="npm" %}
54
87
55
-
1.**Reads the relevant Skill files based on the user's query**, with the assistant retrieving library APIs, code patterns, and best-practice guidance from the installed Syncfusion<supstyle="font-size:70%">®</sup> Skills, and automatically chooses the appropriate platform based on the detected project type.
Choose your installation scope (project-level or global), then confirm to complete the installation.
106
+
107
+
{% tabs %}
108
+
{% highlight bash tabtitle="npm" %}
109
+
110
+
◆ Installation scope
111
+
│ ● Project (Install in current directory (committed with your project))
112
+
│ ○ Global
113
+
114
+
◆ Proceed with installation?
115
+
│ ● Yes / ○ No
116
+
117
+
{% endhighlight %}
118
+
{% endtabs %}
119
+
120
+
This registers the Syncfusion<supstyle="font-size:70%">®</sup> skill pack so your AI assistant can automatically load it in supported IDEs such as [Code Studio](https://help.syncfusion.com/code-studio/reference/configure-properties/skills), [Visual Studio Code](https://code.visualstudio.com/docs/copilot/customization/agent-skills), and [Cursor](https://cursor.com/docs/skills).
121
+
122
+
To learn more about the Skills CLI, refer [here](https://skills.sh/docs).
123
+
124
+
## How Syncfusion<supstyle="font-size:70%">®</sup> DOCX Editor SDK Agent Skills Work
125
+
126
+
1.**Read the relevant skill files and choose modes based on the user's query** - The assistant retrieves component APIs and code patterns from the installed Syncfusion<supstyle="font-size:70%">®</sup> Skills, automatically selecting the appropriate platform based on your workspace or prompt.
57
127
2.**Enforces Syncfusion<supstyle="font-size:70%">®</sup> best practices** including:
58
128
- Suggesting the correct NuGet packages or npm packages based on the detected application type.
59
129
- Using only APIs and code patterns explicitly present in the skill reference files.
@@ -62,19 +132,88 @@ To learn more about the Skills CLI, refer [here](https://skills.sh/docs).
62
132
- Produces production-ready React, Angular, Blazor, ASP.NET Core, TypeScript, or Vue code and inserts it into the user's project files.
63
133
- Triggered by keywords such as `"create"`, `"add"`, `"insert"`, `"apply"`, `"code"`, `"snippet"`, `"how to"`, `"show me"`, `"sample"`, or `"example"`.
64
134
65
-
### Using the AI Assistant
135
+
## Using the AI Assistant
136
+
137
+
Once skills are installed, the assistant can generate docx editor code. Below are some example prompts.
138
+
139
+
**Example Prompts:**
140
+
141
+
- "Create a DOCX Editor and enable track changes"
142
+
- "How to protect documents with comments only restriction in ASP.NET Core DOCX editor?"
143
+
- "How to enable spell checking in DOCX editor?"
144
+
- "How to search for text and replace it in Blazor DOCX editor?"
145
+
146
+
## Skills CLI Commands
147
+
148
+
After installation, manage Syncfusion<supstyle="font-size:70%">®</sup> Agent Skills using the following commands:
149
+
150
+
### List Skills
151
+
152
+
View all installed skills in your current project or global environment:
153
+
154
+
{% tabs %}
155
+
{% highlight bash tabtitle="NPM" %}
156
+
157
+
npx skills list
158
+
159
+
{% endhighlight %}
160
+
{% endtabs %}
161
+
162
+
### Remove a Skill
163
+
164
+
Uninstall a specific skill from your environment:
165
+
166
+
{% tabs %}
167
+
{% highlight bash tabtitle="NPM" %}
168
+
169
+
npx skills remove <skill-name>
170
+
171
+
{% endhighlight %}
172
+
{% endtabs %}
173
+
174
+
Replace `<skill-name>` with the name of the skill you want to remove (for example, `syncfusion-blazor-docx-editor`).
175
+
176
+
### Check for Updates
177
+
178
+
Check if updates are available for your installed skills:
179
+
180
+
{% tabs %}
181
+
{% highlight bash tabtitle="NPM" %}
182
+
183
+
npx skills check
184
+
185
+
{% endhighlight %}
186
+
{% endtabs %}
187
+
188
+
### Update All Skills
189
+
190
+
Update all installed skills to their latest versions:
191
+
192
+
{% tabs %}
193
+
{% highlight bash tabtitle="NPM" %}
194
+
195
+
npx skills update
196
+
197
+
{% endhighlight %}
198
+
{% endtabs %}
199
+
200
+
## FAQ
201
+
202
+
**Which agents and IDEs are supported?**
203
+
204
+
Any Skills compatible agent or IDE that loads local skill files (Visual Studio Code, Cursor, CodeStudio, etc.).
205
+
206
+
**Are skills loaded automatically?**
66
207
67
-
Once skills are installed, the assistant can be used to generate and update Syncfusion<supstyle="font-size:70%">®</sup> docx editor code for tasks such as:
208
+
Yes. Once installed, supported agents automatically detect and load relevant skills for Syncfusion‑related queries without requiring additional configuration.
68
209
69
-
- "Create DOCX Editor and enable track changes"
70
-
- "Insert a table with rows and columns into a Word document."
71
-
- "Insert images within a DOCX file."
72
-
- "Track changes and add comments to specific paragraphs in a Word document."
210
+
**Skills are not being loaded**
73
211
212
+
Verify that skills are installed in the correct agent directory, restart the IDE, and confirm that the agent supports external skill files.
0 commit comments