Skip to content

Commit a5f0a8f

Browse files
committed
Update doc
1 parent 4f28601 commit a5f0a8f

File tree

2 files changed

+19
-11
lines changed

2 files changed

+19
-11
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,20 +27,28 @@ Instructions
2727

2828
Install *pandoc-beamer-block* using the bash command
2929

30-
pip install pandoc-beamer-block
30+
~~~shell
31+
$ pip install pandoc-beamer-block
32+
~~~
3133

3234
To upgrade to the most recent release, use
3335

34-
pip install --upgrade pandoc-beamer-block
36+
~~~shell
37+
$ pip install --upgrade pandoc-beamer-block
38+
~~~
3539

3640
To upgrade to the current code, use
3741

38-
pip install --upgrade --force git+https://github.com/chdemko/pandoc-beamer-block
42+
~~~shell
43+
$ pip install --upgrade --force git+https://github.com/chdemko/pandoc-beamer-block
44+
~~~
3945

4046
`pip` is a script that downloads and installs modules from the Python Package Index, [PyPI]. It should come installed with your python distribution. If you are running linux, `pip` may be bundled separately. On a Debian-based system (including Ubuntu), you can install it as root using
4147

42-
apt-get update
43-
apt-get install python3-pip
48+
~~~shell
49+
$ sudo apt-get update
50+
$ sudo apt-get install python3-pip
51+
~~~
4452

4553
[python]: https://www.python.org
4654
[on Windows]: https://www.python.org/downloads/windows

docs/usage.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,22 @@ decorate `div` elements by blocks
1414
The metadata block add information using the `pandoc-beamer-block` entry
1515
by a list of definitions:
1616

17-
``` yaml
17+
~~~yaml
1818
pandoc-beamer-block:
1919
- classes: [info]
2020
- classes: [alert]
2121
type: alert
22-
```
22+
~~~
2323

2424
The metadata block above is used to add a `block` environment around
2525
`div`s which have `info` class and a `alertblock` environment to `div`s
2626
that have only a `alert` class.
2727

2828
Each entry of `pandoc-beamer-block` is a YAML dictionary containing:
2929

30-
- `classes`: the set of classes of the `div`s to which the
30+
* `classes`: the set of classes of the `div`s to which the
3131
transformation will be applied. This parameter is mandatory.
32-
- `type`: the block type (either `alert`, `example` or `info`)
32+
* `type`: the block type (either `alert`, `example` or `info`)
3333

3434
## Example
3535

@@ -38,11 +38,11 @@ Demonstration: Using
3838
as input gives output file in
3939
[pandoc-beamer-block-sample.pdf](https://raw.githubusercontent.com/chdemko/pandoc-beamer-block/develop/docs/images/pandoc-beamer-block-sample.pdf).
4040

41-
``` console
41+
~~~shell
4242
$ pandoc \
4343
-t beamer \
4444
-V theme:Warsaw \
4545
--filter pandoc-beamer-block \
4646
-o docs/images/pandoc-beamer-block-sample.pdf \
4747
docs/images/pandoc-beamer-block-sample.txt
48-
```
48+
~~~

0 commit comments

Comments
 (0)