Skip to content

Commit

Permalink
never ending story
Browse files Browse the repository at this point in the history
  • Loading branch information
Ducasse committed Nov 2, 2024
1 parent ca80aad commit 267d1de
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions doc/syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,11 @@ For example we refer to Figure *@aFigAnchor@*.

#### Equations

Using the same mechanism you can define a caption and an anchor of an equation.
Using the same mechanism you can define an anchor of an equation.
If the $LaTeX$ style supports caption for equations (this is not the default in $LaTeX$), you can also define caption using the parameters (i.e., `&caption=A caption.`).

```
$$ %anchor=frac&caption=The crazy equation
$$ %anchor=frac
\frac{1}{1+2}
$$
```
Expand All @@ -60,12 +61,12 @@ Microdown supports both inline math using `$` and equation `$$`
`$x^2$` - inline `$\LaTeX$` is done using `$x^2$` (and `$LaTeX$`).

```
$$ %anchor=frac&caption=The crazy equation
$$ %anchor=frac
\frac{1}{1+2}
$$
```

produces a fraction. Notice the use of %anchor=frac to define metadata.
produces a fraction. Notice the use of `%anchor=frac` to define metadata.

$$
\frac{1}{1+2}
Expand All @@ -89,10 +90,11 @@ Headers are done by lines starting with `#`. One `#` is the largest header, six
##### This is a header level 5, done as `##### This is a header level 5`

### Comments

It is possible to put comments in the Microdown source. Lines starting with `%` are creates a comment paragraph, but most tools ignore them.

```
% They really are
% They really are ignored
```

### File level Metadata
Expand All @@ -108,6 +110,7 @@ Microdown uses JSON to handle file-header metadata as shown after:


### Quote blocks

> Lines starting with `>` are supposed to be rendered in an indented manner
> At present the in-image rendering leaves something to be desired
> But it works for now
Expand Down

0 comments on commit 267d1de

Please sign in to comment.