From 973873fb706efd0b10eced89dd750f629394622f Mon Sep 17 00:00:00 2001 From: Radovan Bast Date: Sat, 23 Sep 2023 15:33:14 +0200 Subject: [PATCH] motivation to stick to standard format; closes #205 --- content/tools.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/content/tools.md b/content/tools.md index 66ea1ec..b4d45a2 100644 --- a/content/tools.md +++ b/content/tools.md @@ -41,10 +41,6 @@ We will have a closer look at this in the {ref}`writing-readme-files` episode. ## reStructuredText and Markdown -- Two of the most popular lightweight markup languages. -- reStructuredText (RST) has more features than Markdown but the choice is a matter of taste. -- There are (unfortunately) [many flavors of Markdown](https://github.com/jgm/CommonMark/wiki/Markdown-Flavors). - ```markdown # This is a section in Markdown This is a section in RST ======================== @@ -70,6 +66,11 @@ There is more: images, There is more: images, tables, links, ... tables, links, ... ``` +- Two of the most popular lightweight markup languages. +- reStructuredText (RST) has more features than Markdown but the choice is a matter of taste. +- There are (unfortunately) [many flavors of Markdown](https://github.com/jgm/CommonMark/wiki/Markdown-Flavors). +- Motivation to stick to a standard text-based format: **They make it easier to move the documentation to other tools + which also expect a standard format, as the project/organization grows**. - We will use [MyST](https://myst-parser.readthedocs.io/en/latest/) flavored Markdown in the {ref}`sphinx` episode and the {ref}`gh-pages` example.