pandoc-slide-filter/README.md

88 lines
1.9 KiB
Markdown
Raw Permalink Normal View History

2017-07-25 09:55:12 +00:00
# pandoc-slide-filter
2017-07-25 12:55:44 +00:00
Collection of pandoc-filters for our reveal-js slides.
## How to build
1. [install stack](https://haskell-lang.org/get-started) and do a `stack setup`
2. clone this repository
3. do a `stack build` or `stack install`
`stack build` builds the files but leaves them in `.stack-work/dist/$OS/Cabal-$Cabalversion/build/$exe-dir/$exe-name`.
`stack install` installs them into `$HOME/.local/bin` (or similar on other OSes).
## What is what?
### Media
support for
- `![](foo.aac){#audio}`
- `![](foo.mp4){#video}`
- `![](foo.png){#img}`
- `![](foo.svg){#svg}`
- `![](foo.html){#demo}`
2017-07-27 14:45:24 +00:00
- Automatic detection of filetypes based on file-extensions
- Id's may be changed/omitted in this case
2017-07-25 12:55:44 +00:00
### Styling
support for
- `<div id="col" .w50></div>`
- better code-blocks
- `<div class="fragment"></div>` region revealed after click
- `<div class="frame"></div>` region revealed and then vanishes on next click
- `[]{.fragment}` same for inline-objects
- `[]{.frame}` same for inline-objects
- `[]{#hspace width=100px}` manual spacing
- `[]{#vspace height=100px}` manual spacing
### Quiz
support for
2017-07-27 09:57:12 +00:00
- `[answer-text [with some hover-tooltip]{.tooltip}]{.answer .right width=100px}`
- `[answer-text [and even $\latex$]{.tooltip}]{.answer .wrong}`
- `[simple answer]{.answer .right}`
2017-07-25 12:55:44 +00:00
2017-07-27 09:57:12 +00:00
Note: Tooltip-Syntax has changed.
2017-07-25 12:55:44 +00:00
2017-09-12 09:58:00 +00:00
### Cols
This filter makes multi-column-layouts out of lvl-x-headings
Syntax is
```
## a b
```
yielding a 2-column-layout with aspects a:b i.e. 1:1 for 50/50-layout
or 8:2 for 80/20 layout
currently works for 2 and 3-columns, but extension is straight-forward.
If you need multiple Block-Elements inside one column, just wrap them
with a `<div>` or wait for [#168](https://github.com/jgm/pandoc/issues/168):
```
## 2 5
<div>
multiple things
- foo
- bar
![image](...)
</div>
second column here with only 1 element.
```
2017-07-25 12:55:44 +00:00
### Clean
2017-07-27 09:57:12 +00:00
Small filter for cleaning empty Blocks if they get generated by accident.