Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Documentation/Basics/RstCheatSheet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ Escape characters
=================

If you want to use a character, which would create some special reST markup,
with its normal meaning, you must escape it with a prepended "\".
with its normal meaning, you must escape it with a prepended :rst:`\`.

For example surrounding text with "*" signs normally makes it show up in italics. By
escaping the special characters "*" you make the stars normal text characters:
Expand Down
8 changes: 4 additions & 4 deletions Documentation/Howto/WritingDocForExtension/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ Use the following Docker command to render your documentation guide locally:

.. include:: /_Includes/_LocalRendering.rst.txt

The :ref:`render-documentation-with-docker` has more information.
See :ref:`render-documentation-with-docker` for more information.

.. _how-to-start-docs-extension:

Use the init command to create the Documentation folder
=======================================================

The following Docker command helps you to create some basic documentation
The following Docker command creates some basic documentation
including the required configuration file :file:`Documentation/guides.xml`:

.. include:: /_Includes/_InitCommand.rst.txt
Expand All @@ -40,15 +40,15 @@ The command creates a folder :path:`Documentation` in the directory it is called
from. This should be the root directory of your extension containing the
`composer.json <https://docs.typo3.org/permalink/t3coreapi:files-composer-json>`_.

Follow the interactive dialoge. We suggest to use the option ReStructuredText (rst)
Follow the interactive dialog. We suggest to use the option ReStructuredText (rst)
as this format provides the full power of the TYPO3 documentation theme. Using
Markdown (md) is an option for simple and quick one page documentation.

If your extension offers a main `Site set <https://docs.typo3.org/permalink/t3coreapi:site-sets>`_
enter its name and path when prompted. This will regenerate ready to use
documentation about configuration for you. If you have more then one set you
can document the other sets manually. If you have no set, you need to write
the chapter your self.
the chapter yourself.

Make changes and try :ref:`rendering <rendering-docs>` the new documentation.

Expand Down
Loading