{"id":13425701,"url":"https://github.com/jaspervdj/patat","last_synced_at":"2025-05-13T15:12:39.379Z","repository":{"id":37979856,"uuid":"69011108","full_name":"jaspervdj/patat","owner":"jaspervdj","description":"Terminal-based presentations using Pandoc","archived":false,"fork":false,"pushed_at":"2025-04-05T10:26:22.000Z","size":936,"stargazers_count":2553,"open_issues_count":17,"forks_count":63,"subscribers_count":35,"default_branch":"main","last_synced_at":"2025-04-23T21:43:56.211Z","etag":null,"topics":["haskell","markdown","pandoc","presentation","slides","slideshow","terminal"],"latest_commit_sha":null,"homepage":"","language":"Haskell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jaspervdj.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-09-23T09:37:28.000Z","updated_at":"2025-04-23T11:25:03.000Z","dependencies_parsed_at":"2024-10-25T15:53:05.642Z","dependency_job_id":"46a4c641-c66e-4004-ae04-f40529376ac5","html_url":"https://github.com/jaspervdj/patat","commit_stats":{"total_commits":288,"total_committers":21,"mean_commits":"13.714285714285714","dds":"0.11458333333333337","last_synced_commit":"0b26977c837cd05215ecd1e7b72eee54598ebec0"},"previous_names":[],"tags_count":67,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaspervdj%2Fpatat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaspervdj%2Fpatat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaspervdj%2Fpatat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaspervdj%2Fpatat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jaspervdj","download_url":"https://codeload.github.com/jaspervdj/patat/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253969266,"owners_count":21992264,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["haskell","markdown","pandoc","presentation","slides","slideshow","terminal"],"created_at":"2024-07-31T00:01:17.018Z","updated_at":"2025-05-13T15:12:34.344Z","avatar_url":"https://github.com/jaspervdj.png","language":"Haskell","funding_links":[],"categories":["Haskell","Documentation and Presentation","ASCII","\u003ca name=\"office\"\u003e\u003c/a\u003eOffice tools","Open Source","Presentation Editors","Table of Contents","转换工具"],"sub_categories":["开发组件"],"readme":"🥔 patat\n========\n\n![CI](https://github.com/jaspervdj/patat/actions/workflows/haskell-ci.yml/badge.svg) [![Hackage](https://img.shields.io/hackage/v/patat.svg)](https://hackage.haskell.org/package/patat) [![GitHub tag](https://img.shields.io/github/tag/jaspervdj/patat.svg)]()\n\n`patat` (**P**resentations **A**top **T**he **A**NSI **T**erminal) is a\nfeature-rich presentation tool that runs in the terminal.\n\n- Understands most markdown extensions and many other input formats\n  (rST, Org-mode...) by building on top of [Pandoc].\n- [Evaluate code snippets and show the result](#evaluating-code).\n- Syntax highlighting for nearly one hundred languages generated from [Kate]\n  syntax files.\n- [Automatically reload](#running) your slides as you edit them.\n- Display [speaker notes](#speaker-notes) in a second window or monitor.\n- [Incremental slide display](#fragmented-slides).\n- Experimental [images](#images) support.\n- [Transition effects](#transitions).\n- Supports [smart slide splitting](#input-format).\n- [Auto advancing](#auto-advancing) with configurable delay.\n- [Centering](#centering) and [re-wrapping](#line-wrapping) text to terminal\n  width with proper indentation.\n- [Theming](#theming) support including 24-bit RGB.\n- Highly portable as it only requires an ANSI terminal as opposed to\n  something like `ncurses`.\n\n![screenshot](extra/demo.gif?raw=true)\n\n[Kate]: https://kate-editor.org/\n[Pandoc]: http://pandoc.org/\n\nTable of Contents\n-----------------\n\n-   [Table of Contents](#table-of-contents)\n-   [Installation](#installation)\n    -   [Pre-built packages](#pre-built-packages)\n    -   [From source](#from-source)\n-   [Running](#running)\n-   [Options](#options)\n-   [Controls](#controls)\n-   [Input format](#input-format)\n-   [Configuration](#configuration)\n    -   [Line wrapping](#line-wrapping)\n    -   [Tab stop](#tab-stop)\n    -   [Margins](#margins)\n    -   [Auto advancing](#auto-advancing)\n    -   [Advanced slide splitting](#advanced-slide-splitting)\n    -   [Fragmented slides](#fragmented-slides)\n    -   [Theming](#theming)\n    -   [Syntax Highlighting](#syntax-highlighting)\n    -   [Pandoc Extensions](#pandoc-extensions)\n    -   [Images](#images)\n    -   [Breadcrumbs](#breadcrumbs)\n    -   [Slide numbers](#slide-numbers)\n    -   [Evaluating code](#evaluating-code)\n    -   [Speaker notes](#speaker-notes)\n    -   [Transitions](#transitions)\n    -   [Links](#links)\n-   [Trivia](#trivia)\n\nInstallation\n------------\n\n### Pre-built packages\n\nLinux:\n\n- [Archlinux](https://aur.archlinux.org/packages/patat-bin)\n- [Debian](https://packages.debian.org/unstable/patat)\n- [Fedora](https://src.fedoraproject.org/rpms/patat)\n- [NixOS](https://search.nixos.org/packages?show=haskellPackages.patat)\n- [openSUSE](https://build.opensuse.org/package/show/openSUSE:Factory:ARM/patat)\n- [Ubuntu](https://packages.ubuntu.com/bionic/patat)\n\nMac OS:\n\n- [Homebrew](https://formulae.brew.sh/formula/patat)\n\nYou can also find generic Linux and Mac OS binaries here:\n\u003chttps://github.com/jaspervdj/patat/releases\u003e.\n\n### From source\n\n`patat` is also available from [Hackage].  You can install it using [cabal] by\nrunning `cabal install patat`.\n\n[cabal]: https://www.haskell.org/cabal/\n[Hackage]: https://hackage.haskell.org/package/patat\n\nRunning\n-------\n\n`patat [*options*] file`\n\nOptions\n-------\n\n`-w`, `--watch`\n\n:   If you provide the `--watch` flag, `patat` will watch the presentation file\n    for changes and reload automatically.  This is very useful when you are\n    writing the presentation.\n\n`-f`, `--force`\n\n:   Run the presentation even if the terminal claims it does not support ANSI\n    features.\n\n`-d`, `--dump`\n\n:   Just dump all the slides to stdout.  This is useful for debugging.\n\n`--version`\n\n:   Display version information.\n\nControls\n--------\n\n- **Next slide**: `space`, `enter`, `l`, `→`, `PageDown`\n- **Previous slide**: `backspace`, `h`, `←`, `PageUp`\n- **Go forward 10 slides**: `j`, `↓`\n- **Go backward 10 slides**: `k`, `↑`\n- **First slide**: `0`\n- **Last slide**: `G`\n- **Jump to slide N**: `N` followed by `enter`\n- **Reload file**: `r`\n- **Quit**: `q`\n\nThe `r` key is very useful since it allows you to preview your slides while you\nare writing them.  You can also use this to fix artifacts when the terminal is\nresized.\n\nInput format\n------------\n\nThe input format can be anything that Pandoc supports.  Plain markdown is\nusually the most simple solution:\n\n```markdown\n---\ntitle: This is my presentation\nauthor: Jane Doe\n...\n\n# This is a slide\n\nSlide contents.  Yay.\n\n---\n\n# Important title\n\nThings I like:\n\n- Markdown\n- Haskell\n- Pandoc\n```\n\nHorizontal rulers (`---`) are used to split slides.\n\nHowever, if you prefer not use these since they are a bit intrusive in the\nmarkdown, you can also start every slide with a header.  In that case, the file\nshould not contain a single horizontal ruler.\n\n`patat` will pick the most deeply nested header (e.g. `h2`) as the marker for a\nnew slide.  Headers _above_ the most deeply nested header (e.g. `h1`) will turn\ninto title slides, which are displayed as as a slide containing only the\ncentered title.\n\nThis means the following document is equivalent to the one we saw before:\n\n```markdown\n---\ntitle: This is my presentation\nauthor: Jane Doe\n...\n\n# This is a slide\n\nSlide contents.  Yay.\n\n# Important title\n\nThings I like:\n\n- Markdown\n- Haskell\n- Pandoc\n```\n\nAnd that following document contains three slides: a title slide, followed by\ntwo content slides.\n\n```markdown\n---\ntitle: This is my presentation\nauthor: Jane Doe\n...\n\n# Chapter 1\n\n## This is a slide\n\nSlide contents.  Yay.\n\n## Another slide\n\nThings I like:\n\n- Markdown\n- Haskell\n- Pandoc\n```\n\nFor more information, see [Advanced slide splitting](#advanced-slide-splitting).\n\nConfiguration\n-------------\n\n`patat` is fairly configurable.  The configuration is done using [YAML].  There\nare several places where you can put your configuration.\n\n1.  For per-user configuration you can use\n    `$XDG_CONFIG_DIRECTORY/patat/config.yaml`\n    (typically `$HOME/.config/patat/config.yaml`) or `$HOME/.patat.yaml`, for\n    example:\n\n    ```yaml\n    slideNumber: false\n    ```\n\n2.  In the presentation file itself, using the [Pandoc metadata header].\n    These settings take precedence over anything specified in the per-user\n    configuration file.  They must be placed in a `patat:` section, so they\n    don't conflict with metadata:\n\n    ```markdown\n    ---\n    title: Presentation with options\n    author: John Doe\n    patat:\n        slideNumber: false\n    ...\n\n    Hello world.\n    ```\n\n3.  In version 0.10 and later slides can be individually configured.\n    Within a slide, using a comment starting with `\u003c!--config:`.  These\n    settings can override configuration for that specific slide only.\n    There should not be any whitespace between `\u003c!--` and `config:`.\n\n    ```markdown\n    # First slide\n\n    Slide numbers are turned on here.\n\n    # Second slide\n\n    \u003c!--config:\n    slideNumber: false\n    --\u003e\n\n    Slide numbers are turned off here.\n    ```\n\n    The following settings can **not** be set in a slide configuration block,\n    and doing so will result in an error:\n\n     -  `autoAdvanceDelay`\n     -  `eval`\n     -  `images`\n     -  `incrementalLists`\n     -  `pandocExtensions`\n     -  `slideLevel`\n     -  `speakerNotes`\n\n[YAML]: http://yaml.org/\n[Pandoc metadata header]: http://pandoc.org/MANUAL.html#extension-yaml_metadata_block\n\n### Line wrapping\n\nLine wrapping can be enabled by setting `wrap: true` in the configuration.  This\nwill re-wrap all lines to fit the terminal width better.  You can also ask patat\nto wrap at a specific column using `wrap: number`, e.g. `wrap: 60`.\n\n### Tab stop\n\nIn version 0.12 and later, the amount of spaces a `\\t` character in a code block\naligns to can be customized by setting `tabStop: number` in the configuration.\nThe default is `4`.\n\n### Margins\n\nMargins can be enabled by setting a `margins` entry in the configuration:\n\n```markdown\n---\ntitle: Presentation with margins\nauthor: John Doe\npatat:\n    wrap: true\n    margins:\n        left: 10\n        right: 10\n        top: 5\n...\n\nLorem ipsum dolor sit amet, ...\n```\n\nThis example configuration will generate slides with a margin of 10 columns on\nthe left, and it will wrap long lines 10 columns before the right side of the\nterminal.  Additionally, there will be 5 empty lines in between the title bar\nand slide content.\n\n[Line wrapping](#line-wrapping) should be enabled when using non-zero `right`\nmargin.\n\nBy default, the `left` and `right` margin are set to 0, and the `top` margin is\nset to 1.\n\n#### Centering\n\nVersion 0.11 and later can center content.\n\n -  To vertically center content, use `top: auto`.\n -  To horizontally center content, use both `left: auto` and `right: auto`.\n\nFor example:\n\n```markdown\n---\ntitle: Centered presentation\nauthor: John Doe\npatat:\n    margins:\n        left: auto\n        right: auto\n        top: auto\n...\n\nHello world\n```\n\n[Line wrapping](#line-wrapping) is recommended when vertically centering content\nif there are any lines that are too wide for the terminal.\n\n### Auto advancing\n\nBy setting `autoAdvanceDelay` to a number of seconds, `patat` will automatically\nadvance to the next slide.\n\n```markdown\n---\ntitle: Auto-advance, yes please\nauthor: John Doe\npatat:\n    autoAdvanceDelay: 2\n...\n\nHello World!\n\n---\n\nThis slide will be shown two seconds after the presentation starts.\n```\n\nNote that changes to `autoAdvanceDelay` are not picked up automatically if you\nare running `patat --watch`.  This requires restarting `patat`.\n\n### Advanced slide splitting\n\nYou can control the way slide splitting works by setting the `slideLevel`\nvariable.  This variable defaults to the least header that occurs before a\nnon-header, but it can also be explicitly defined.  For example, in the\nfollowing document, the `slideLevel` defaults to **2**:\n\n```markdown\n# This is a slide\n\n## This is a nested header\n\nThis is some content\n```\n\nWith `slideLevel` 2, the `h1` will turn into a \"title slide\", and the `h2` will\nbe displayed at the top of the second slide.  We can customize this by setting\n`slideLevel` manually:\n\n```markdown\n---\npatat:\n  slideLevel: 1\n...\n\n# This is a slide\n\n## This is a nested header\n\nThis is some content\n```\n\nNow, we will only see one slide, which contains a nested header.\n\n### Fragmented slides\n\nBy default, slides are always displayed \"all at once\".  If you want to reveal\nthem fragment by fragment, there are two ways to do that.  The most common\ncase is that lists should be displayed incrementally.\n\nThis can be configured by settings `incrementalLists` to `true` in the metadata\nblock:\n\n```markdown\n---\ntitle: Presentation with incremental lists\nauthor: John Doe\npatat:\n    incrementalLists: true\n...\n\n- This list\n- is displayed\n- item by item\n```\n\nSetting `incrementalLists` works on _all_ lists in the presentation.  To flip\nthe setting for a specific list, wrap it in a block quote.  This will make the\nlist incremental if `incrementalLists` is not set, and it will display the list\nall at once if `incrementalLists` is set to `true`.\n\nThis example contains a sublist which is also displayed incrementally, and then\na sublist which is displayed all at once (by merit of the block quote).\n\n```markdown\n---\ntitle: Presentation with incremental lists\nauthor: John Doe\npatat:\n    incrementalLists: true\n...\n\n- This list\n- is displayed\n\n    * item\n    * by item\n\n- Or sometimes\n\n    \u003e * all at\n    \u003e * once\n```\n\nAnother way to break up slides is to use a pagraph only containing three dots\nseparated by spaces.  For example, this slide has two pauses:\n\n```markdown\nLegen\n\n. . .\n\nwait for it\n\n. . .\n\nDary!\n```\n\n### Theming\n\nColors and other properties can also be changed using this configuration.  For\nexample, we can have:\n\n```markdown\n---\nauthor: 'Jasper Van der Jeugt'\ntitle: 'This is a test'\npatat:\n    wrap: true\n    theme:\n        emph: [vividBlue, onVividBlack, italic]\n        strong: [bold]\n        imageTarget: [onDullWhite, vividRed]\n...\n\n# This is a presentation\n\nThis is _emph_ text.\n\n![Hello](foo.png)\n```\n\nThe properties that can be given a list of styles are:\n\n`blockQuote`, `borders`, `bulletList`, `codeBlock`, `code`, `definitionList`,\n`definitionTerm`, `emph`, `header`, `imageTarget`, `imageText`, `linkTarget`,\n`linkText`, `math`, `orderedList`, `quoted`, `strikeout`, `strong`,\n`tableHeader`, `tableSeparator`, `underline`\n\nThe accepted styles are:\n\n`bold`, `italic`, `dullBlack`, `dullBlue`, `dullCyan`, `dullGreen`,\n`dullMagenta`, `dullRed`, `dullWhite`, `dullYellow`, `onDullBlack`,\n`onDullBlue`, `onDullCyan`, `onDullGreen`, `onDullMagenta`, `onDullRed`,\n`onDullWhite`, `onDullYellow`, `onVividBlack`, `onVividBlue`, `onVividCyan`,\n`onVividGreen`, `onVividMagenta`, `onVividRed`, `onVividWhite`, `onVividYellow`,\n`underline`, `vividBlack`, `vividBlue`, `vividCyan`, `vividGreen`,\n`vividMagenta`, `vividRed`, `vividWhite`, `vividYellow`\n\nAlso accepted are styles of the form `rgb#RrGgBb` and `onRgb#RrGgBb`, where `Rr`\n`Gg` and `Bb` are hexadecimal bytes (e.g. `rgb#f08000` for an orange foreground,\nand `onRgb#101060` for a deep purple background).  Naturally, your terminal\nneeds to support 24-bit RGB for this to work.  When creating portable\npresentations, it might be better to stick with the named colours listed above.\n\nTo customize the color of the `underline`, combine the prefix with a color, for\nexample:\n\n```yaml\npatat:\n    theme:\n        strong: [underline, underlineVividBlue]\n```\n\n### Syntax Highlighting\n\n`patat` uses [Kate] Syntax Highlighting files.  `patat` ships with support for\nnearly one hundred languages thanks to Pandoc.  However, if your language is\nnot yet available, you can add the highlighting XML file in the settings:\n\n```markdown\n---\npatat:\n  syntaxDefinitions:\n  - 'impurescript.xml'\n...\n\n...\n```\n\nAs part of theming, syntax highlighting is also configurable.  This can be\nconfigured like this:\n\n```markdown\n---\npatat:\n  theme:\n    syntaxHighlighting:\n      decVal: [bold, onDullRed]\n...\n\n...\n```\n\n`decVal` refers to \"decimal values\".  This is known as a \"token type\".  For a\nfull list of token types, see [this list] -- the names are derived from there in\nan obvious way.\n\n[this list]: https://hackage.haskell.org/package/highlighting-kate-0.6.3/docs/Text-Highlighting-Kate-Types.html#t:TokenType\n\nNote that in order to get syntax highlighting to work, you should annotate code\nblocks with the language, e.g. using a fenced code block:\n\n    ```ruby\n    puts \"Hello, world!\"\n    ```\n\n### Pandoc Extensions\n\nPandoc comes with a fair number of extensions on top of markdown, listed [here](https://hackage.haskell.org/package/pandoc-2.0.5/docs/Text-Pandoc-Extensions.html).\n\n`patat` enables a number of them by default, but this is also customizable.\n\nIn order to enable an additional extensions, e.g. `autolink_bare_uris`, add it\nto the `pandocExtensions` field in the YAML metadata:\n\n```markdown\n---\npatat:\n  pandocExtensions:\n    - patat_extensions\n    - autolink_bare_uris\n...\n\nDocument content...\n```\n\nThe `patat_extensions` in the above snippet refers to the default set of\nextensions enabled by `patat`.  If you want to disable those and only use a\nselect few extensions, simply leave it out and choose your own:\n\n```markdown\n---\npatat:\n  pandocExtensions:\n    - autolink_bare_uris\n    - emoji\n...\n\nDocument content...\n```\n\nIf you don't want to enable any extensions, simply set `pandocExtensions` to the\nempty list `[]`.\n\n\n### Images\n\n#### Native Images support\n\nVersion 0.8 and later include images support for some terminal emulators.\n\n```markdown\n---\npatat:\n  images:\n    backend: auto\n...\n\n# A slide with only an image.\n\n![](matterhorn.jpg)\n```\n\n`patat` can display full-size images on slides. For this to work `images` must be enabled in the configuration and the slide needs to contain only a single image and no other content. The image will be centered and resized to fit the terminal window.\n\n`images` is off by default in the configuration.\n\n`patat` supports the following image drawing backends:\n\n-   `backend: iterm2`: uses [iTerm2](https://iterm2.com/)'s special escape\n    sequence to render the image.  This even works with animated GIFs!\n    Note that it can have issues running under `tmux`.\n\n-   `backend: kitty`: uses\n    [Kitty's icat command](https://sw.kovidgoyal.net/kitty/kittens/icat.html).\n\n-   `backend: wezterm`: uses the iTerm2 image protocol as implemented by\n    WezTerm.\n\n-   `backend: w3m`: uses the `w3mimgdisplay` executable to draw directly onto\n    the window.  This has been tested in `urxvt` and `xterm`, but is known to\n    produce weird results in `tmux`.\n\n    If `w3mimgdisplay` is in a non-standard location, you can specify that using\n    `path`:\n\n    ```yaml\n    backend: 'w3m'\n    path: '/home/jasper/.local/bin/w3mimgdisplay'\n    ```\n\n#### Images using Evaluation\n\nRather than using the built-in image support, you can also use programs that\nwrite ASCII escape codes directly to the screen with\n[code evaluation](#evaluating-code).\n\nIn order to do that, for example, we could configure `kitten` code snippets\nto evaluate using [Kitty]'s command `icat`.  This uses the `none` container\nsetting to ensure that the resulting output is not wrapped in a code block,\nand the `reveal` and `replace` settings immediately replace the snippet.\n\n    ---\n    patat:\n      eval:\n        kitten:\n          command: sed 's/^/kitten /' | bash\n          replace: true\n          reveal: false\n          container: none\n    ...\n\n    See, for example:\n\n    ```kitten\n    icat --align left dank-meme.jpg\n    ```\n\n### Breadcrumbs\n\nBy default, `patat` will print a breadcrumbs-style header, e.g.:\n\n    example.md \u003e This is a title \u003e This is a subtitle\n\nThis feature can be turned off by using:\n\n```yaml\npatat:\n  breadcrumbs: false\n```\n\n### Slide numbers\n\nBy default, `patat` will display slide number in bottom-right corner\n\nThis feature can be turned off by using:\n\n```yaml\npatat:\n  slideNumber: false\n```\n\n### Evaluating code\n\n`patat` can evaluate code blocks and show the result.  You can register an\n_evaluator_ by specifying this in the YAML metadata:\n\n    ---\n    patat:\n      eval:\n        ruby:\n          command: irb --noecho --noverbose\n          reveal: true  # Optional\n          replace: false  # Optional\n          container: code  # Optional\n    ...\n\n    Here is an example of a code block that is evaluated:\n\n    ```ruby\n    puts \"Hi\"\n    ```\n\nAn arbitrary amount of evaluators can be specified, and whenever a a class\nattribute on a code block matches the evaluator, it will be used.\n\n**Note that executing arbitrary code is always dangerous**, so double check the\ncode of presentations downloaded from the internet before running them if they\ncontain `eval` settings.\n\nAside from the command, there are four more options:\n\n -  `reveal`: Introduce a pause (see [fragments](#fragmented-slides)) in\n    between showing the original code block and the output.  Defaults to `true`.\n -  `replace`: Remove the original code block and replace it with the output\n    rather than appending the output in a new code block.  Defaults to `false`.\n -  `container`: By default, the output is wrapped in a code block again with\n    the original syntax highlighting.  You can customize this behaviour by\n    setting `container` to:\n     *  `code`: the default setting.\n     *  `none`: no formatting applied.\n     *  `inline`: no formatting applied and no trailing newline.\n -  `stderr`: Include output from standard error.  Defaults to `true`.\n -  `wrap`: this is a deprecated name for `container`, used in version 0.11 and\n    earlier.\n -  `fragment`: this is a deprecated name for `reveal`, used in version 0.13 and\n    earlier.\n\nSetting `reveal: false` and `replace: true` offers a way to \"filter\" code\nblocks, which can be used to render ASCII graphics.\n\n    ---\n    patat:\n      eval:\n        figlet:\n          command: figlet\n          reveal: false\n          replace: true\n    ...\n\n    ```figlet\n    Fancy Font\n    ```\n\nThis feature works by simply by:\n\n1.  Spawn a process with the provided command\n2.  Write the contents of the code block to the `stdin` of the process\n3.  Wait for the process to exit\n4.  Render the `stdout` of the process\n\n### Speaker Notes\n\nVersion 0.9 and later support comments which can be used as speaker notes.\n\n```markdown\n---\ntitle: This is my presentation\nauthor: Jane Doe\n...\n\n# Chapter 1\n\n\u003c!--\nNote: I should not bore the audience with my thoughts on powerpoint but\njust get straight to the point.\n--\u003e\n\nSlide contents.  Yay.\n\n\u003c!-- TODO: Finish the rest of the presentation. --\u003e\n```\n\nYou can also configure `patat` to write the speaker notes for the current slide\nto a file whenever the slide changes:\n\n```yaml\npatat:\n  speakerNotes:\n    file: /tmp/notes.txt\n```\n\nThen, you can display these in a second terminal (presumably on a second\nmonitor) by just displaying this file whenever it changes. `tail` is a primitive\nway of doing that:\n\n```bash\ntail -F /tmp/notes.txt\n```\n\nAlternatively, just use a second `patat` instance with `--watch` enabled:\n\n```bash\npatat -w /tmp/notes.txt\n```\n\nNote that speaker notes should not start with `\u003c!--config:`, since then they\nwill be parsed as [configuration](#configuration) blocks.  They are allowed\nto start with `\u003c!-- config:`; the lack of whitespace matters.\n\n### Transitions\n\nVersion 0.10 and later support transitions in between slides.  A relatively\nfast terminal emulator (e.g. [Alacritty], [Kitty], [iTerm2]) is suggested when\nenabling this, to avoid too much flickering -- some flickering is unavoidable\nsince we redraw the entire screen on each frame.\n\n```yaml\npatat:\n  transition:\n    type: slideLeft\n```\n\nTo set transitions on specific slides, use `\u003c!--config:` blocks, as detailed\nin the [configuration section](#configuration).  For example:\n\n```markdown\n# Slide one\n\nSlide one content.\n\n# Slide two\n\n\u003c!--config:\ntransition:\n  type: slideLeft\n  duration: 2\n--\u003e\n\nSlide two content.\n```\n\nSupported transitions `type`s:\n\n -  `slideLeft`: slides the new slide in from right to left.\n -  `dissolve`: changes characters over time.\n -  `matrix`: loosely inspired by the 1999 science fiction movie.\n\nAll transitions currently take these arguments:\n\n -  `frameRate`: number of frames per second.  Defaults to 24.\n -  `duration`: duration of the animation in seconds.  Defaults to 1.\n\n#### Random transitions\n\nYou can set `type` to `random` to randomly pick a transition effect.\n\n```yaml\npatat:\n  transition:\n    type: random\n    items:\n    - type: dissolve\n      duration: 3\n    - type: slideLeft\n      frameRate: 10\n```\n\nYou can optionally set `items` to a non-empty list of transition effects to\nrandomly sample from.  If `items` is not set, `patat` will simply sample from\nall transition effects using their respective default settings.\n\n### Links\n\nVersion 0.15.0.0 and later support [OSC8] for hyperlinks.  This makes hyperlinks\nclickable in many terminal emulators (see [OSC8 adoption]).\n\nThere is currently no way to detect if a terminal supports this feature, so you\nneed to explicitly turn this on in the configuration:\n\n```yaml\npatat:\n  links:\n    osc8: true\n```\n\n[OSC8]: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda\n[OSC8 adoption]: https://github.com/Alhadis/OSC8-Adoption\n\nTrivia\n------\n\n_\"Patat\"_ is the Flemish word for a simple potato.  Dutch people also use it to\nrefer to French Fries but I don't really do that -- in Belgium we just call\nfries _\"Frieten\"_.\n\nThe idea of `patat` is largely based upon [MDP] which is in turn based upon\n[VTMC].  I wanted to write a clone using Pandoc because I ran into a markdown\nparsing bug in MDP which I could not work around.  A second reason to do a\nPandoc-based tool was that I would be able to use [Literate Haskell] as well.\nLastly, I also prefer not to install Node.js on my machine if I can avoid it.\n\n[MDP]: https://github.com/visit1985/mdp\n[VTMC]: https://github.com/jclulow/vtmc\n[Literate Haskell]: https://wiki.haskell.org/Literate_programming\n\n[Alacritty]: https://alacritty.org/\n[iTerm2]: https://iterm2.com/\n[Kitty]: https://sw.kovidgoyal.net/kitty/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaspervdj%2Fpatat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjaspervdj%2Fpatat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaspervdj%2Fpatat/lists"}