Note
This version of the guide covers the new PHP-based rendering of Documentation with the TYPO3 Documentation theme.
If the project you are looking at has a file Documentation/guides.xml it is using the new rendering.
Otherwise, consider to migrate the Documentation or head over to the legacy version of this guide: How to document, Sphinx based.
Writing documentation¶
- Version
-
main
- Language
-
en
- Author
-
TYPO3 contributors
- License
-
This document is published under the Creative Commons BY 4.0 license.
- Rendered
-
Fri, 26 Apr 2024 10:27:40 +0000
This guide contains information about contributing to TYPO3 documentation, writing documentation for TYPO3 extensions and formatting with reStructuredText (reST).
Migration¶
Migrate your documentation to the new, PHP-based reST rendering.
Cheat sheet: reStructuredText¶
Go tho the cheat sheet containing a quick overview on how to use reStructuredText.
Edit on GitHub¶
This chapter explains how to apply quick changes to the documentation you are reading by applying the "Edit on GitHub" workflow. All you need is a GitHub account.
Local rendering¶
Using your local machine instead of editing documentation on GitHub has many advantages, it includes the freedom to choose which IDE you make your changes in and it also gives you the ability to experiment and preview your changes locally before submitting them for approval.
Extension documentation¶
This chapter explains how to write documentation for a new extension.
System Extensions¶
The chapter contains information on how you can make changes to system extension documentation.