Getting Started

This manual introduces you to writing TYPO3 documentation. You can read it cover-to-cover.

But often, you would like to jump right in, start with a specific task and learn as you go along. In that case, pick a task in the list below.

Tip

Before you start, we recommend that you read Basic Principles to familiarize yourself with the structure and reStructuredText & Sphinx Introduction. Additionally, keep the reST & Sphinx Cheat Sheet handy to look up the syntax.

Find your task here and start reading:

  • How to Start Documentation for Your TYPO3 Extension if you have an extension and would like to write documentation for it
  • Contribute if you would like to contribute to the official documentation and need an easy introduction to editing documentation directly on GitHub. This does not require any development tools, you just need a browser and a GitHub account.
  • Local Editing and Rendering with Docker if you would like to contribute to the official documentation and are already familiar with Git and Docker
  • Render Documentation if you would like to start with rendering the documentation locally with Docker.