How to Document TYPO3

Version: main
Language: en
Author: TYPO3 contributors
License: This document is published under the Creative Commons BY 4.0 license.
Rendered: Fri, 22 Nov 2024 15:05:16 +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.

How to migrate to the new rendering

Cheat sheet: reStructuredText

Go tho the cheat sheet containing a quick overview on how to use reStructuredText.

Go to the reST Cheat sheet

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.

How to make quick fixes

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.

How to work locally with documentation

Extension documentation

This chapter explains how to write documentation for a new extension.

How to document an extension

System Extensions

The chapter contains information on how you can make changes to system extension documentation.

How to document system extensions