diff --git a/doc/create_game.md b/doc/create_game.md index 8d2c3f7..cb5c0c4 100644 --- a/doc/create_game.md +++ b/doc/create_game.md @@ -194,7 +194,7 @@ You can but a `Statement` inside namespaces like you would with `theorem`. #### Doc String / Exercise statement -Add a docstring that contains the exercise statement in natural language. If you do this, it will appear at the top of the exercise. It supports Latex. +Add a docstring that contains the exercise statement in natural language. If you do this, it will appear at the top of the exercise. It supports KateX. ```lean /-- The exercise statement in natural language using latex: $\iff$. -/ @@ -265,13 +265,7 @@ CoverImage "images/cover.png" * `Prerequisites` a list of other games you should play before this one, e.g. `Prerequisites "NNG" "STG"`. The game names are free-text. * `CoverImage`: You can create a folder `images/` and put images there for the game to use. The maximal ratio is ca. 500x200 (W x H) but it might be cropped horizontally on narrow screens. -## Further Notes - -Here are some random further things you should consider designing a new game: - -* Inside strings, you need to escape backslashes, but not inside doc-strings, therefore you - would write `Introduction "some latex here: $\\iff$."` but - `/-- some latex here: $\iff$. -/ Statement ...` -* A world with more than 16 levels will be displayed with the levels spiraling outwards, - it might be desirable to stay below that bound. Above 22 levels the spiral starts getting out - of control. +## Number Of Levels Limit +A world with more than 16 levels will be displayed with the levels spiraling outwards, +it might be desirable to stay below that bound. Above 22 levels the spiral starts getting out +of control. diff --git a/doc/hints.md b/doc/hints.md index 87bc7d9..bc1f299 100644 --- a/doc/hints.md +++ b/doc/hints.md @@ -120,3 +120,19 @@ $$ ``` See https://www.jmilne.org/not/Mamscd.pdf + +### Truth Tables +KateX does not support the tabular environment. You can use the array environment instead. +``` +$$ +\\begin{array}{|c|c|} +\\hline +P & ¬P \\\\ +\\hline +T & F \\\\ +F & T \\\\ +\\hline +\\end{array} +$$ +``` + diff --git a/doc/latex.md b/doc/latex.md new file mode 100644 index 0000000..cb191a4 --- /dev/null +++ b/doc/latex.md @@ -0,0 +1,8 @@ +# Syntax +Inside strings, you need to escape backslashes, but not inside doc-strings, therefore you + would write `Introduction "some latex here: $\\iff$."` but + `/-- some latex here: $\iff$. -/ Statement ...` + +# Support +It is important to mention that KateX supports most but not all of latex and its packages. +See [supported](https://katex.org/docs/supported.html).