PHPackages georgringer/doc - 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. [Parsing & Serialization](/categories/parsing) 4. / 5. georgringer/doc ActiveTypo3-cms-extension[Parsing & Serialization](/categories/parsing) georgringer/doc =============== Render documentation based on markdown files directly in the backend 1.1.1(4y ago)2232.7k↓50%10[5 issues](https://github.com/georgringer/doc/issues)GPL-2.0-or-laterCSS Since Jan 29Pushed 1y ago4 watchersCompare [ Source](https://github.com/georgringer/doc)[ Packagist](https://packagist.org/packages/georgringer/doc)[ Docs](https://ringer.it)[ Fund](https://paypal.me/GeorgRinger/10)[ Fund](https://www.amazon.de/hz/wishlist/ls/8F573K08TSDG)[ RSS](/packages/georgringer-doc/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (3)Dependencies (1)Versions (6)Used By (0) TYPO3 Extension `doc` ===================== [](#typo3-extension-doc) This extension adds an option to the *Help* menu called *Project Documentation*, that lets you deliver documentation about your project from within TYPO3 CMS backend. [![Help](Resources/Public/Images/Help.png)](Resources/Public/Images/Help.png) The extension also ships with a widget for the TYPO3 Dashboad extension to give you quick access to your project documentation. [![Widget](Resources/Public/Images/Widget.png)](Resources/Public/Images/Widget.png) The documentation is based on Markdown. This makes it easy to write documentation while you're building a custom extension, or afterward. You could include descriptions of content elements, release notes, instructions for raising issues or anything else that needs to be documented. The JS library [docsify](https://docsify.js.org/) transforms **markdown files** into beautiful HTML content. [![Demo](Resources/Public/Images/Demo.png)](Resources/Public/Images/Demo.png) Setup the extension ------------------- [](#setup-the-extension) Download the extension. Use one of the following options: 1. *Composer*: `composer req georgringer/doc` 2. *TER*: Download extension from [TER](https://extensions.typo3.org/extension/doc/) 3. *TYPO3 Backend*: Download extension in *Extension Manager* ### Configuration [](#configuration) Switch to **Install Tool/Settings** and customize the global configuration. As seen in the screenshot below, the following configuration options are available: - `Documentation Root Path`: Define the path to the Markdown files - `Documentation Name`: Documentation name as it appears in the sidebar - `Dark mode`: Enable the dark mode [![Extension Configuration](Resources/Private/ExampleDocs/_img/ExtensionConfiguration.png)](Resources/Private/ExampleDocs/_img/ExtensionConfiguration.png) Write the documentation ----------------------- [](#write-the-documentation) > Without any documentation, this extension is not useful at all :) Check out the sample documentation included in this extension which you can use as a guide `EXT:doc/Resources/Private/ExampleDocs`. See also the [Markdown Cheatsheet](Resources/Private/ExampleDocs/Setup/Markdown.md) as there are some nice features available. When you create your own documentation make sure to put the folder with your markdown files in `Resources/Private`. Otherwise your markdown files may be publicly accessible. ### Health Score 37 — LowBetter than 83% of packages Maintenance24 Infrequent updates — may be unmaintained Popularity37 Limited adoption so far Community17 Small or concentrated contributor base Maturity57 Maturing project, gaining track record Bus Factor2 2 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 ~438 days Total 4 Last Release 620d ago Major Versions 1.1.1 → v12.x-dev2024-09-06 ### Community Maintainers ![](https://www.gravatar.com/avatar/1d08c176686c8914d32c70d4af388887d738930fdfdf07c7ca9c841ad10ed683?d=identicon)[georgringer](/maintainers/georgringer) --- Top Contributors [![georgringer](https://avatars.githubusercontent.com/u/1905663?v=4)](https://github.com/georgringer "georgringer (14 commits)")[![peterkraume](https://avatars.githubusercontent.com/u/4234704?v=4)](https://github.com/peterkraume "peterkraume (10 commits)")[![flicstar](https://avatars.githubusercontent.com/u/10190723?v=4)](https://github.com/flicstar "flicstar (8 commits)")[![Rathch](https://avatars.githubusercontent.com/u/35492663?v=4)](https://github.com/Rathch "Rathch (2 commits)") --- Tags documentationtypo3-cms-extensiontypo3-extensiondocumentationmarkdowntypo3 ### Embed Badge ![Health badge](/badges/georgringer-doc/health.svg) ``` [![Health](https://phpackages.com/badges/georgringer-doc/health.svg)](https://phpackages.com/packages/georgringer-doc) ``` ### Alternatives [justinwalsh/daux.io Documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly 4.6k38.1k1](/packages/justinwalsh-dauxio)[daux/daux.io Documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly 825191.0k1](/packages/daux-dauxio)[bookdown/bookdown Provides DocBook-like rendering of Markdown files. 8257.6k16](/packages/bookdown-bookdown)[dniccum/nova-documentation A Laravel Nova tool that allows you to add markdown-based documentation to your administrator's dashboard. 37116.4k](/packages/dniccum-nova-documentation)[dudo1985/wpdocgen Documentation Generator for WordPress. 2327.6k](/packages/dudo1985-wpdocgen)[tobiju/bookdown-bootswatch-templates Bookdown.io With Bootswatch Styles And Prism Syntax Highlighting 1619.6k1](/packages/tobiju-bookdown-bootswatch-templates) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)