mirror of
https://github.com/mfontanini/presenterm.git
synced 2026-09-01 23:33:21 -06:00
chore: add docs for 0.12.0
This commit is contained in:
parent
ca0a8b3453
commit
3715bfa4da
@ -68,6 +68,19 @@ defaults:
|
||||
max_columns_alignment: left
|
||||
```
|
||||
|
||||
## Incremental lists behavior
|
||||
|
||||
By default, [incremental lists](../features/commands.md) will pause before and after a list. If you would like to change
|
||||
this behavior, use the `defaults.incremental_lists` key:
|
||||
|
||||
```yaml
|
||||
defaults:
|
||||
incremental_lists:
|
||||
# The defaults, change to false if desired.
|
||||
pause_before: true
|
||||
pause_after: true
|
||||
```
|
||||
|
||||
# Key bindings
|
||||
|
||||
Key bindings that _presenterm_ uses can be manually configured in the config file via the `bindings` key. The following
|
||||
@ -219,4 +232,15 @@ speaker_notes:
|
||||
always_pubblish: true
|
||||
```
|
||||
|
||||
## PDF export size
|
||||
|
||||
The size of exported PDFs can be configured via the `export.dimensions` key:
|
||||
|
||||
```yaml
|
||||
export:
|
||||
dimensions:
|
||||
columns: 80
|
||||
rows: 30
|
||||
```
|
||||
|
||||
See [the PDF export page](../features/pdf-export.md) for more information.
|
||||
|
||||
@ -94,3 +94,30 @@ If you don't want the footer to show up in some particular slide for some reason
|
||||
<!-- no_footer -->
|
||||
```
|
||||
|
||||
## Skip slide
|
||||
|
||||
If you don't want a specific slide to be included in the presentation use the `skip_slide` command:
|
||||
|
||||
```html
|
||||
<!-- skip_slide -->
|
||||
```
|
||||
|
||||
## Text alignment
|
||||
|
||||
The text alignment for the remainder of the slide can be configured via the `alignment` command, which can use values:
|
||||
`left`, `center`, and `right`:
|
||||
|
||||
```markdown
|
||||
<!-- alignment: left -->
|
||||
|
||||
left alignment, the default
|
||||
|
||||
<!-- alignment: center -->
|
||||
|
||||
centered
|
||||
|
||||
<!-- alignment: right -->
|
||||
|
||||
right aligned
|
||||
```
|
||||
|
||||
|
||||
@ -1,21 +1,15 @@
|
||||
# Exporting presentations in PDF format
|
||||
|
||||
Presentations can be converted into PDF by using a [helper tool](https://github.com/mfontanini/presenterm-export). You
|
||||
can install it by running:
|
||||
Presentations can be converted into PDF by using [weasyprint](https://pypi.org/project/weasyprint/). Follow their
|
||||
[installation instructions](https://doc.courtbouillon.org/weasyprint/stable/first_steps.html) since it may require you
|
||||
to install extra dependencies for the tool to work.
|
||||
|
||||
```bash
|
||||
pip install presenterm-export
|
||||
```
|
||||
> [!note]
|
||||
> If you were using _presenterm-export_ before, that tool already required _weasyprint_ so it is already installed in
|
||||
> whatever virtual env you were using and there's nothing to be done.
|
||||
|
||||
> [!important]
|
||||
> Make sure that `presenterm-export` works by running `presenterm-export --version` before attempting to generate a PDF
|
||||
> file. If you get errors related to _weasyprint_, follow their [installation instructions](https://doc.courtbouillon.org/weasyprint/stable/first_steps.html) to ensure you meet all of their
|
||||
> dependencies. This has otherwise caused issues in macOS.
|
||||
|
||||
_presenterm-export_ uses [tmux](https://github.com/tmux/tmux/) to run _presenterm_ inside it and capture its output.
|
||||
|
||||
After you've installed both _presenterm-export_ and _tmux_, run _presenterm_ with the `--export-pdf` parameter to
|
||||
generate the output PDF:
|
||||
After you've installed _weasyprint_, run _presenterm_ with the `--export-pdf` parameter to generate the output PDF:
|
||||
|
||||
```bash
|
||||
presenterm --export-pdf examples/demo.md
|
||||
@ -24,22 +18,13 @@ presenterm --export-pdf examples/demo.md
|
||||
The output PDF will be placed in `examples/demo.pdf`.
|
||||
|
||||
> [!note]
|
||||
> If you're using a separate virtual env to install _presenterm-export_ just make sure you activate it before running
|
||||
> If you're using a separate virtual env to install _weasyprint_ just make sure you activate it before running
|
||||
> _presenterm_ with the `--export-pdf` parameter.
|
||||
|
||||
## Page sizes
|
||||
## PDF page size
|
||||
|
||||
The size of each page in the generated PDF will depend on the size of your terminal. Make sure to adjust accordingly
|
||||
before running the command above, and not to resize it while the generation is happening to avoid issues.
|
||||
By default, the size of each page in the generated PDF will depend on the size of your terminal.
|
||||
|
||||
## tmux <= 3.5a active sessions bug
|
||||
If you would like to instead configure the dimensions by hand, set the `export.dimensions` key in the configuration file
|
||||
as described in the [settings page](../configuration/settings.md#pdf-export-size).
|
||||
|
||||
Because of a [bug in tmux <= 3.5a](https://github.com/tmux/tmux/issues/4268), exporting a PDF while having other tmux
|
||||
sessions running and attached will cause the size of the output PDF to match the size of those other sessions rather
|
||||
than the size of the terminal you're running _presenterm_ in. The workaround is to only have one attached tmux session
|
||||
and to run the PDF export from that session.
|
||||
|
||||
## How it works
|
||||
|
||||
The conversion into PDF format is pretty convoluted. If you'd like to learn more visit
|
||||
[presenterm-export](https://github.com/mfontanini/presenterm-export)'s repo.
|
||||
|
||||
@ -69,17 +69,18 @@ when used.
|
||||
|
||||
Currently, the following themes are supported:
|
||||
|
||||
* `dark`: A dark theme.
|
||||
* `light`: A light theme.
|
||||
* `tokyonight-storm`: A theme inspired by the colors used in [toyonight](https://github.com/folke/tokyonight.nvim).
|
||||
* A set of themes based on the [catppuccin](https://github.com/catppuccin/catppuccin) color palette:
|
||||
* `catppuccin-latte`
|
||||
* `catppuccin-frappe`
|
||||
* `catppuccin-macchiato`
|
||||
* `catppuccin-mocha`
|
||||
* `dark`: A dark theme.
|
||||
* `gruvbox`: A theme inspired by the colors used in [gruvbox](https://github.com/morhetz/gruvbox).
|
||||
* `light`: A light theme.
|
||||
* `terminal-dark`: A theme that uses your terminals color and looks best if your terminal uses a dark color scheme. This
|
||||
means if your terminal background is e.g. transparent, or uses an image, the presentation will inherit that.
|
||||
means if your terminal background is e.g. transparent, or uses an image, the presentation will inherit that.
|
||||
* `terminal-light`: The same as `terminal-dark` but works best if your terminal uses a light color scheme.
|
||||
* `tokyonight-storm`: A theme inspired by the colors used in [toyonight](https://github.com/folke/tokyonight.nvim).
|
||||
|
||||
## Trying out built-in themes
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user