Command line tools¶
This project provides two entrypoints of command line tools.
rst2typst command¶
This is entrypoint to generate Typst code from reStructuredText.
Usage¶
rst2typst [options] [<source> [<destination>]]
source is path of reStructuredText file.
destination is output path of Typst file. If destination is not specified, it outputs into STDOUT.
Options¶
- --template
Template for render code.
- Type:
path string (
<filepath>)- Default:
Path of built-in template
rst2typst computes translated strings and renders them using template. When you want to inject custom strings into head or foot of output, you can specify a template file path that has them.
- --page-break-level
Section level for page-break.
- Type:
Comma separated integers (
<int>(,<int>...))- Default:
empty string (it means
[])
Many PDF files as e-book usually have page breaks at high level sections. This values explicit which section level should break page.
rst2typstpdf command¶
Entrypoint to generate PDF bypassing Typst code.
Important
You need to install this with “pdf” extra to run this command.
Usage¶
rst2typstpdf [options] [<source> [<destination>]]
source is path of reStructuredText file.
destination is output path of Typst file. If destination is not specified, it outputs into STDOUT.
Options¶
These are same from options for rst2typst command command.
- --font-paths
List of directories where custom fonts are stored.
- Type:
List of string
- Default:
Empty list (
[])
This option specifies folders that contain custom font files in addition to the system font folders. You should pass a folder path if you want to use extra fonts when generating a PDF.
Examples¶
Simple generate¶
$ rst2typst input.rst output.typ
Break pages at top-level sections¶
$ rst2typst --page-break-level=1 input.rst output.typ
Use custom template¶
$ cat ./template.txt
#page("a5")
{imports}
{includes}
{body}
$ rst2typst --template=./template.txt input.rst output.typ
Generate PDF¶
$ rst2typstpdf input.rst output.pdf