mirror/presenterm
1
0
Fork 1
mirror of https://github.com/mfontanini/presenterm.git synced 2026-09-01 23:33:21 -06:00
Code Releases Activity

docs: add notes on running bat directly

Browse Source
This commit is contained in:
Matias Fontanini 2024-11-16 13:36:11 -08:00
parent 7479395fe3
commit 792ed7c1b4
2 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/src/guides/code-highlight.md
View File

@ -259,3 +259,20 @@ block is transformed into an image, allowing you to define formulas as text in y
using the `+render` attribute on a code block.
See the [LaTeX and typst](latex.html) and [mermaid](mermaid.html) docs for more information.
### Adding highlighting syntaxes for new languages
_presenterm_ uses the syntaxes supported by [bat](https://github.com/sharkdp/bat) to highlight code snippets, so any
languages supported by _bat_ natively can be added to _presenterm_ easily. Please create a ticket or use
[this](https://github.com/mfontanini/presenterm/pull/385) as a reference to submit a pull request to make a syntax
officially supported by _presenterm_ as well.
If a language isn't natively supported by _bat_ but you'd like to use it, you can follow
[this guide in the bat docs](https://github.com/sharkdp/bat#adding-new-syntaxes--language-definitions) and
invoke _bat_ directly in a presentation:
~~~markdown
```bash +exec_replace
bat --color always script.py
```
~~~

4
docs/src/guides/pdf-export.md
View File

@ -19,8 +19,8 @@ simply run _presenterm_ with the `--export-pdf` parameter to generate the output
presenterm --export-pdf examples/demo.md
```
The output PDF will be placed in `examples/demo.pdf`. The size of each page will depend on the size of your terminal so
make sure to adjust accordingly before running the command above.
The output PDF will be placed in `examples/demo.pdf`. **The size of each page will depend on the size of your terminal**
so make sure to adjust accordingly before running the command above.
> Note: if you're using a separate virtual env to install _presenterm-export_ just make sure you activate it before
> running _presenterm_ with the `--export-pdf` parameter.