Llenguatge de marques#
Les accions de formatació més comunes i simples són suportades de forma nativa tant en rST com en MyST, i si esteu llegint això, el més probable és que ja sapigueu quina sintaxi utilitzar per a coses com títols, llistes de pics o text en negreta.
També es pot aconseguir un format més complex (o funcionalitat especial!) amb rols i directrius, dos conceptes clau en Sphinx que s’expliquen en les pàgines següents. Els recursos següents generalment combinen llenguatge de marques, rols i directrius (sense distingir si el seu objectiu és de format o no).
Hi ha un aspecte molt important que sovint es passa per alt, però que és clau tant per a rST com per a MyST, que és que tots dos permeten imbricar marques i directrius. Vegeu per vosaltres mateixos:
Comencem amb una enumeració
Dins de l’enumeració citem una secció d’alguna documentació
Important
La documentació consisteix en una capsa d’informació amb codi a l’interior
print("Nested formatting yay!")
Continuem la llista i Markdown reconeix que és la mateixa llista enlloc de començar-ne una de nova
1. We start with a numbered list
> Within the list we quote a section of some documentation
>
> :::{important}
> The documentation has an info box with some code inside it:
>
> ```
> print("Nested formatting yay!")
> ```
> :::
1. We continue the list and markdown knows that it's the same list and not a new one.
rST |
MyST |
|---|---|