Skip to content

Commit

Permalink
Merge pull request #734 from ljhwang/patch-51
Browse files Browse the repository at this point in the history
Update important_syntax.md
  • Loading branch information
gassmoeller authored Jun 2, 2024
2 parents d25e810 + 0e0573a commit 14a9963
Showing 1 changed file with 3 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
Important syntax
===============

The world builder is using [sphinx](https://www.sphinx-doc.org) to generate the documentation. Sphinx accepts multiple variants of extended markdown, but in this project we are using [myst](https://myst-parser.readthedocs.io). Below we list some common commands to use.
The World Builder is using [sphinx](https://www.sphinx-doc.org) to generate the documentation. Sphinx accepts multiple variants of extended markdown, but in this project we are using [myst](https://myst-parser.readthedocs.io). Below we list some common commands to use.

:::{note}
Everything in this file will look like garbage in a regular markdown viewer, like if you’re viewing this on github. Viewing it on readthedocs will render everything properly.
Everything in this file will look like garbage in a regular markdown viewer, like if you’re viewing this on GitHub. Viewing it on readthedocs will render everything properly.
:::

(title)=
Expand Down Expand Up @@ -75,7 +75,7 @@ Links are written in the following way:

# Admonitions

Adding notes, warnings or and todos which stand out can be done with the following syntax:
Adding notes, warnings or todos boxes can be done with the following syntax:

::::{code-block} md
:::{todo}
Expand Down

0 comments on commit 14a9963

Please sign in to comment.