From edf564a63ca677902af2b59d3c33a7e93cd923cc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phaneDucasse?= Date: Fri, 23 Feb 2024 11:01:09 +0100 Subject: [PATCH] Update README.md --- README.md | 39 ++++++++++++++++++++++++++++++++++++--- 1 file changed, 36 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a6232199..8726c78d 100644 --- a/README.md +++ b/README.md @@ -74,13 +74,29 @@ There are three ways to create anchors - % comments - *** horizontal line -- `$$` mathematical environment +- File meta data is plain JSON + +``` +{ +"date" : "12 december 2025" +} +``` + +### Math support + +- `$$` mathematical environment + +``` +$$%key=cite&label=refToTheGreatEquation +V_i = C_0 - C_3 +$$ +``` - Math in text ``` 'abc$ V_i = C_0 - C_3 $def'. ``` -will generate LaTeX $ V_i = C_0 - C_3 $ +will generate LaTeX equivalent. ### Codeblock @@ -104,8 +120,25 @@ codeBlockMarkupString ### Extensions +- `{! aTag | parameters!}` is the way to use an extension with parameters +- Environments are defined using `` + +``` + + +!> +!> +!> +``` - Citations `{!citation|ref=Blac09a!}` -- note that the bib file should be defined in the pillar.conf file - + + ## Known limits #### Math should be tested