PHPackages typo3/cms-documentation - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Admin Panels](/categories/admin) 4. / 5. typo3/cms-documentation ActiveTypo3-cms-framework[Admin Panels](/categories/admin) typo3/cms-documentation ======================= Backend module for TYPO3 to list and show documentation of loaded extensions as well as custom documents. v9.3.3(7y ago)274.6k1GPL-2.0-or-laterPHPCI failing Since Sep 7Pushed 6y ago6 watchersCompare [ Source](https://github.com/TYPO3-CMS/documentation)[ Packagist](https://packagist.org/packages/typo3/cms-documentation)[ Docs](https://typo3.org)[ RSS](/packages/typo3-cms-documentation/feed)WikiDiscussions 9.3 Synced today READMEChangelogDependencies (1)Versions (37)Used By (1) Documentation ============= [](#documentation) This extension provides a Backend module for TYPO3 to show both the documentation of local extensions and custom documents. The Backend module features two actions: 1. Show Documentation 2. Download Documentation Show Documentation ------------------ [](#show-documentation) This view shows a list of available documents: - Extensions with a manual rendered as `html` or `pdf`; - Extensions with an OpenOffice manual (`sxw`); - Official TYPO3 documentation (tutorials, references, ...) available locally; - Custom documents, rendered either as `html` or `pdf`. To be listed, documents should be stored within `typo3conf/Documentation////`: `documentation-key`Extensions use the documentation key `typo3cms.extensions.`.`language`Either "default" (for English) or a proper locale identifying your translated documentation. E.g., `fr_FR`, `fr_CA`, `de_DE` ...`format`Either `html` or `pdf`. Additional formats may be supported by 3rd party extensions (such as [EXT:sphinx](https://typo3.org/extensions/repository/view/sphinx)).### Registering Custom Documents [](#registering-custom-documents) 1. Choose a documentation key such as `.` 2. Put your documentation as HTML (main file *must be* `Index.html`) within `typo3conf/Documentation//default/html/` or as PDF (any name will fit) within `typo3conf/Documentation//default/pdf/` 3. Create a text description file `composer.json` containing the title and description of your documentation and place it within `typo3conf/Documentation//default/`: ``` { "name": "Put some title here", "type": "documentation", "description": "Put some description here." } ``` 4. \[optionally\] Put a custom icon (either `icon.png` or `icon.gif`) within directory `typo3conf/Documentation//` Download Documentation ---------------------- [](#download-documentation) This view is only accessible to TYPO3 administrators. It shows a form to retrieve rendered documentation for loaded extensions and to fetch a copy of official TYPO3 manuals, guides and references from . Configuration ------------- [](#configuration) There are two User TSconfig options available: mod.help\_DocumentationDocumentation.documents.hideComma-separated list of keys of documentation that should be hidden from the user.mod.help\_DocumentationDocumentation.documents.showComma-separated list of keys of documentation that should be shown to the user (others are implicitly hidden). ### Health Score 40 — FairBetter than 86% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity27 Limited adoption so far Community27 Small or concentrated contributor base Maturity75 Established project with proven stability Bus Factor4 4 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~26 days Recently: every ~12 days Total 37 Last Release 2285d ago Major Versions v8.7.13 → v9.2.12018-05-22 v8.7.15 → v9.3.02018-06-11 v8.7.17 → v9.3.12018-07-12 v8.7.18 → v9.3.32018-07-31 v8.7.30 → 9.2.x-dev2020-02-11 PHP version history (4 changes)v8.7.7PHP >=7.0.0 <=7.1.99 v8.7.9PHP >=7.0.0 <=7.2.99 v8.7.23PHP ^7.0 <7.4 v8.7.30PHP ^7.0 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/88698?v=4)[TYPO3 GitHub Department](/maintainers/typo3)[@TYPO3](https://github.com/TYPO3) ![](https://avatars.githubusercontent.com/u/165630?v=4)[Benni Mack](/maintainers/bmack)[@bmack](https://github.com/bmack) ![](https://avatars.githubusercontent.com/u/402145?v=4)[Oliver Hader](/maintainers/ohader)[@ohader](https://github.com/ohader) --- Top Contributors [![wouter90](https://avatars.githubusercontent.com/u/1637330?v=4)](https://github.com/wouter90 "wouter90 (41 commits)")[![bmack](https://avatars.githubusercontent.com/u/165630?v=4)](https://github.com/bmack "bmack (27 commits)")[![xperseguers](https://avatars.githubusercontent.com/u/646805?v=4)](https://github.com/xperseguers "xperseguers (15 commits)")[![NeoBlack](https://avatars.githubusercontent.com/u/1128085?v=4)](https://github.com/NeoBlack "NeoBlack (14 commits)")[![ohader](https://avatars.githubusercontent.com/u/402145?v=4)](https://github.com/ohader "ohader (14 commits)")[![lolli42](https://avatars.githubusercontent.com/u/2178068?v=4)](https://github.com/lolli42 "lolli42 (14 commits)")[![liayn](https://avatars.githubusercontent.com/u/222377?v=4)](https://github.com/liayn "liayn (13 commits)")[![helhum](https://avatars.githubusercontent.com/u/904370?v=4)](https://github.com/helhum "helhum (9 commits)")[![neufeind](https://avatars.githubusercontent.com/u/910025?v=4)](https://github.com/neufeind "neufeind (6 commits)")[![georgringer](https://avatars.githubusercontent.com/u/1905663?v=4)](https://github.com/georgringer "georgringer (6 commits)")[![7elix](https://avatars.githubusercontent.com/u/878514?v=4)](https://github.com/7elix "7elix (5 commits)")[![NamelessCoder](https://avatars.githubusercontent.com/u/2228052?v=4)](https://github.com/NamelessCoder "NamelessCoder (3 commits)")[![maddy2101](https://avatars.githubusercontent.com/u/1925287?v=4)](https://github.com/maddy2101 "maddy2101 (3 commits)")[![IchHabRecht](https://avatars.githubusercontent.com/u/1453345?v=4)](https://github.com/IchHabRecht "IchHabRecht (3 commits)")[![tmaroschik](https://avatars.githubusercontent.com/u/771756?v=4)](https://github.com/tmaroschik "tmaroschik (3 commits)")[![andreaskienast](https://avatars.githubusercontent.com/u/1787983?v=4)](https://github.com/andreaskienast "andreaskienast (3 commits)")[![mbrodala](https://avatars.githubusercontent.com/u/5037116?v=4)](https://github.com/mbrodala "mbrodala (2 commits)")[![benjaminkott](https://avatars.githubusercontent.com/u/3243119?v=4)](https://github.com/benjaminkott "benjaminkott (2 commits)")[![alexanderschnitzler](https://avatars.githubusercontent.com/u/711459?v=4)](https://github.com/alexanderschnitzler "alexanderschnitzler (2 commits)")[![pgampe](https://avatars.githubusercontent.com/u/855238?v=4)](https://github.com/pgampe "pgampe (1 commits)") ### Embed Badge ![Health badge](/badges/typo3-cms-documentation/health.svg) ``` [![Health](https://phpackages.com/badges/typo3-cms-documentation/health.svg)](https://phpackages.com/packages/typo3-cms-documentation) ``` ### Alternatives [friendsoftypo3/content-blocks TYPO3 CMS Content Blocks - Content Types API | Define reusable components via YAML 103519.9k53](/packages/friendsoftypo3-content-blocks)[typo3/cms-beuser TYPO3 CMS Backend User - TYPO3 backend module Administration > Users for managing backend users and groups. 179.2M139](/packages/typo3-cms-beuser)[typo3/cms-info TYPO3 CMS Info - TYPO3 backend module for displaying information, such as a pagetree overview and localization information. 169.1M146](/packages/typo3-cms-info)[typo3/cms-adminpanel TYPO3 CMS Admin Panel - The Admin Panel displays information about your site in the frontend and contains a range of metrics including debug and caching information. 115.7M66](/packages/typo3-cms-adminpanel)[netresearch/rte-ckeditor-image Image support in CKEditor for the TYPO3 ecosystem - by Netresearch 611.1M8](/packages/netresearch-rte-ckeditor-image)[wazum/sluggi TYPO3 extension for URL slug management with inline editing, auto-sync, locking, access control, and redirects 40529.5k](/packages/wazum-sluggi) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)