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: SKILL.md
+55-9Lines changed: 55 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
name: typo3-docs
3
-
description: "Create and maintain TYPO3 extension documentation following official docs.typo3.org standards. Use when creating/editing Documentation/*.rst files or README.md, using TYPO3 directives (confval, versionadded, card-grid), creating/adding screenshots, rendering/testing/viewing docs locally, or deploying to docs.typo3.org. By Netresearch."
3
+
description: "Create and maintain TYPO3 extension documentation following official docs.typo3.org standards. Use when creating/editing Documentation/*.rst files or README.md, using TYPO3 directives (confval, versionadded, card-grid, accordion, tabs, admonitions), creating/adding screenshots, rendering/testing/viewing docs locally, or deploying to docs.typo3.org. By Netresearch."
4
4
---
5
5
6
6
# TYPO3 Documentation
@@ -11,7 +11,7 @@ description: "Create and maintain TYPO3 extension documentation following offici
11
11
- Creating new `Documentation/` directory structure
12
12
- Editing `Documentation/**/*.rst` files
13
13
- Creating `Documentation/guides.xml` or updating `Settings.cfg`
14
-
- Using TYPO3 directives: `confval`, `versionadded`, `card-grid`, `php:class`
14
+
- Using TYPO3 directives: `confval`, `versionadded`, `card-grid`, `accordion`, `tabs`
15
15
- Using text roles: `:php:`, `:file:`, `:guilabel:`, `:ref:`
| Alternative examples |`tabs`| Multi-language code, variants |
178
+
| Version changes |`versionadded`, `deprecated`| API changes |
179
+
180
+
### Admonitions (Use Appropriately)
181
+
182
+
```rst
183
+
.. note::
184
+
Background information users should know.
185
+
186
+
.. tip::
187
+
Helpful suggestion for better results.
188
+
189
+
.. warning::
190
+
Potential issue or data loss risk.
191
+
```
192
+
193
+
### Tabs (Synchronized)
194
+
195
+
```rst
196
+
.. tabs::
197
+
198
+
.. group-tab:: Composer
199
+
200
+
Run :bash:`composer require vendor/package`
201
+
202
+
.. group-tab:: Classic
203
+
204
+
Download and install manually.
205
+
```
206
+
207
+
Tabs with the same name synchronize across the page.
208
+
209
+
See `references/content-directives.md` for complete guide.
210
+
167
211
## Required File Structure
168
212
169
213
Full documentation requires this structure (per [TYPO3 File Structure](https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Reference/FileStructure.html)):
@@ -263,13 +307,15 @@ See `references/screenshots.md` for complete guidelines.
263
307
4.**Code blocks**: Have `:caption:`, correct language, valid syntax
264
308
5.**Configuration**: Uses `confval` directive with `:type:`, `:default:`
0 commit comments