MatthiasQuintern/bUwUma
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
matthias@arch 2022-12-16 07:47:09 +01:00
parent e0f7b16639
commit c3a4df491e
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -124,7 +124,7 @@ An entry is a html heading with a id: `<h1 id=myheading>This heading will be lin
sidenav-command must be one of the following: sidenav-command must be one of the following:
#### `include` #### `include`
Include the generated sidenav at this position. Include the generated sidenav at this position. This command will always be executed last, after the whole file has been parsed.
**Argument**: **Argument**:
Ignored Ignored
@ -166,6 +166,7 @@ Empty string
## Pitfalls ## Pitfalls
- The `#include` command must not be in the last line of the file - The `#include` command must not be in the last line of the file
- The `#include` command can not be in multiline comment if the included file also contains comments
- The maps in `set` must have **at least 2** options - The maps in `set` must have **at least 2** options
- If you want to use variables in markdown, you have to escape the `#` with a backslash, so `#$(var)` becomes `\#$(var)` - If you want to use variables in markdown, you have to escape the `#` with a backslash, so `#$(var)` becomes `\#$(var)`
- You can not use the `return` command from within the arguments of other commands. Commands are executed in order, so `return` will end up as argument of the first command and thus never be executed - You can not use the `return` command from within the arguments of other commands. Commands are executed in order, so `return` will end up as argument of the first command and thus never be executed