typo3-docs | typo3-docs | ClaudePluginHub

Skill

Community

typo3-docs

From typo3-docs

1

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.

AI Summary

Creates and maintains TYPO3 extension documentation following official standards. Use when writing RST files with TYPO3 directives (confval, card-grid, tabs), rendering locally, or deploying to docs.typo3.org.

Install

1

Add the repository(one-time)

$

/plugin marketplace add netresearch/typo3-docs-skill

2

Install the plugin

$

/plugin install typo3-docs@netresearch-claude-code-marketplace

Tool Access

This skill inherits all available tools. When active, it can use any tool Claude has access to.

Supporting Assets

View in Repository

references/architecture-decision-records.md

references/code-structure-elements.md

references/coding-guidelines.md

references/content-directives.md

references/documentation-coverage-analysis.md

references/extraction-patterns.md

references/file-structure.md

references/guides-xml.md

references/intercept-deployment.md

references/rendering.md

references/rst-syntax.md

references/screenshots.md

references/text-roles-inline-code.md

references/typo3-directives.md

references/typo3-extension-architecture.md

scripts/add-agents-md.sh

scripts/analyze-docs.sh

scripts/extract-all.sh

scripts/extract-build-configs.sh

scripts/extract-composer.sh

Skill Content

TYPO3 Documentation

When to Use

Creating documentation from scratch → Use docker run ... init (see references/rendering.md)
Editing Documentation/**/*.rst files
Using TYPO3 directives: confval, versionadded, card-grid, accordion, tabs
Using text roles: :php:, :file:, :guilabel:, :ref:
Creating/adding screenshots
Rendering/testing/viewing documentation
Deploying to docs.typo3.org

Core Workflow

Read reference files for the task (see table below)
Use TYPO3 directives, not plain text
Validate: scripts/validate_docs.sh
Render: scripts/render_docs.sh
Verify visually in browser
Keep README.md and Documentation/ synchronized

Critical: When user asks to "show docs", render and display HTML output, not raw RST.

Reference Files

Task	Reference
File structure, naming	`references/file-structure.md`
guides.xml config	`references/guides-xml.md`
Coding guidelines, .editorconfig	`references/coding-guidelines.md`
Code blocks, confval, PHP domain	`references/code-structure-elements.md`
Content directives (accordion, tabs, cards)	`references/content-directives.md`
Rendering, testing, viewing	`references/rendering.md`
Screenshots and images	`references/screenshots.md`
Text roles (`:php:`, `:file:`, etc.)	`references/text-roles-inline-code.md`
RST syntax (headings, lists)	`references/rst-syntax.md`
TYPO3 directives (confval, card-grid)	`references/typo3-directives.md`
Webhook/deployment	`references/intercept-deployment.md`

Critical Rules

UTF-8, 4-space indent, 80 char max, LF endings
CamelCase file/directory names, sentence case headings
Index.rst required in every subdirectory
PNG screenshots with :alt: text
.editorconfig required in Documentation/ (see references/coding-guidelines.md)

Element Selection

Content Type	Use
Code (5+ lines)	`literalinclude` (preferred)
Short snippets	`code-block` with `:caption:`
Config options	`confval` with `:type:`, `:default:`
PHP API	`php:class::`, `php:method::`
Notices	`note`, `tip`, `warning`
Grids	`card-grid`
Alternatives	`tabs` (synchronized)
Collapsible	`accordion`

See references/code-structure-elements.md and references/content-directives.md for syntax.

Scripts

Script	Purpose
`scripts/validate_docs.sh`	Validate RST syntax
`scripts/render_docs.sh`	Render with Docker
`scripts/watch_docs.sh`	Live-view (watch mode)

Pre-Commit Checklist

.editorconfig exists in Documentation/
Every directory has Index.rst, CamelCase naming
4-space indent, no tabs, max 80 chars
Code blocks have :caption:, valid syntax
Inline code uses roles (:php:, :file:)
scripts/validate_docs.sh passes
Visual verification of rendered HTML
README.md and Documentation/ consistent

Contributing: https://github.com/netresearch/typo3-docs-skill

Links

GitHub Stats

0 forks

Updated 1 day ago

Similar Skills

algorithmic-art

Creating algorithmic art using p5.js with seeded randomness and interactive parameter exploration. Use this when users request creating art using code, generative art, algorithmic art, flow fields, or particle systems. Create original algorithmic art rather than copying existing artists' work to avoid copyright violations.

anthropic-skills

35.7k

brand-guidelines

Applies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply.

anthropic-skills

35.7k

Create beautiful visual art in .png and .pdf documents using design philosophy. You should use this skill when the user asks to create a poster, piece of art, design, or other static piece. Create original visual designs, never copying existing artists' work to avoid copyright violations.

anthropic-skills

35.7k