Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
BilalM04 committed May 23, 2024
1 parent 2dba65d commit f161644
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ Please follow the installation instructions in the [mdBook Documentation](https:

## mdBook Quirks

- Have to wrap text reference anchors in `<a id=""></a>` to be able to be referenced.
- Have to wrap certain elements in `<div id=""></div>` to be able to be referenced.
- Cannot add captions to tables and images. Have to use `<p align="center">CAPTION</p>`.
- Mathjax LaTeX equations do not wrap similar to LaTeX (`$EQUATION$`) or HTML (`\(EQUATION\)`). mdBook syntax is `\\(EQUATION\\)` for inline and `\\[EQUATION\\]` for block equations.
- Some elements of equations require an extra `\`. Ex. new line is `\\\`.
- `\symbf` does not work in Mathjax LaTeX equations, have to use `\boldsymbol` instead.
- Typical list syntax does not work inside tables in Markdown. Have to wrap in `<ul> <li>item1</li> <li>item2</li> </ul>`.
- Accessible assets (Ex. images) need to be inside the `src` folder in order to be rendered.
- Accessible assets (Ex. images) need to be inside the `src` folder in order to be rendered. NOTE: There may be a way to use assets outside `src` through the `book.toml`
- Sometimes there is very little space or no space at all between components. Added `</br>` to add extra space.
- Need to add mathjax support in the `book.toml`. Not added by default.

Expand Down

0 comments on commit f161644

Please sign in to comment.