diff --git a/Documentation/Basics/MdCheatSheet.rst b/Documentation/Basics/MdCheatSheet.rst new file mode 100644 index 0000000..c9ad82b --- /dev/null +++ b/Documentation/Basics/MdCheatSheet.rst @@ -0,0 +1,150 @@ +:navigation-title: Markdown Cheat Sheet +.. include:: /Includes.rst.txt + +.. _md-cheat-sheet: + +====================================================================== +Markdown Cheat sheet: Using Commonmark Markdown in TYPO3 Documentation +====================================================================== + +.. contents:: Cheat Sheet + +.. _md-cheat-sheet-headlines-anchors: + +Headlines and Anchors +===================== + +Each document must have a title of level 1. You can use headers of additional +levels, only use level 1 once per Markdown document + +.. code-block:: md + + # Document header + + Some text. + + ## H2 Headline + + Lorem Ipsum + + ### H3 Headline + + Lorem Ipsum + +.. _md-cheat-sheet-links: + +References and linking +====================== + +References to documentation from the TYPO3 world should be copied from the wizard: + +.. figure:: /_Images/link-headlines.png + + Hover over a headline to see if it is linkable, then click the link icon + +They then look like this: + +.. code-block:: md + + [Configuration of the rendering - guides.xml](https://docs.typo3.org/permalink/h2document:guides-xml) + +External links can be copied into the document they will be auto detected. Or +the standard md Syntax can be used: + +.. code-block:: md + + See also https://www.typo3.org or (the TER)[https://extensions.typo3.org]. + +.. _md-cheat-sheet-code-blocks: + +Code blocks +=========== + +Use the standard Markdown syntax for code blocks: + +.. code-block:: md + + ```php + ` + + +.. _md-cheat-sheet-lists: + +Lists, ordered and unordered +============================ + +.. code-block:: md + + - unordered + - Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam + nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, + sed diam voluptua. + - list + + 1. ordered + 2. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam + nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, + sed diam voluptua. + 10. list + +.. _md-cheat-sheet-inline: + +Inline text roles +================= + +.. code-block:: md + + *italic text*, **bold text**, `$code = 'My Code'` + +.. _md-cheat-sheet-comments: + +Comments +======== + +Comments can be written like this: + +.. code-block:: md + + + +.. _md-cheat-sheet-admonitions: + +Admonitions +=========== + +We support the rendering of the following GitHub Markdown style admonitions +(Warning, Tip, etc): + +.. code-block:: md + + > [!NOTE] + > Useful information that users should know, even when skimming content. + + > [!TIP] + > Helpful advice for doing things better or more easily. + + > [!IMPORTANT] + > Key information users need to know to achieve their goal. + + > [!WARNING] + > Urgent info that needs immediate user attention to avoid problems. + + > [!CAUTION] + > Advises about risks or negative outcomes of certain actions. diff --git a/Documentation/Basics/RstCheatSheet.rst b/Documentation/Basics/RstCheatSheet.rst index 502cc0e..30ec899 100644 --- a/Documentation/Basics/RstCheatSheet.rst +++ b/Documentation/Basics/RstCheatSheet.rst @@ -72,14 +72,16 @@ They then look like this: .. code-block:: rst - :ref:`Cheat sheet: reStructuredText ` + `ReST Cheat sheet `_ + +Permalinks are automatically checked and resolved during rendering. External links can be copied into the document they will be auto detected. Or the standard reST Syntax can be used: .. code-block:: rst - See also https://www.typo3.org or `the TER `. + See also https://www.typo3.org or `the TER `_. There are special links for composer packages and PHP classes (linking to the API): diff --git a/Documentation/Index.rst b/Documentation/Index.rst index 38124b8..91c87a5 100644 --- a/Documentation/Index.rst +++ b/Documentation/Index.rst @@ -95,6 +95,7 @@ reStructuredText (reST). Basics/HowToGetHelp Basics/BasicPrinciples Basics/RstCheatSheet + Basics/MdCheatSheet .. toctree::