Merge pull request #191 from mfontanini/prepare-0.6.0

Prepare 0.6.0 release

CHANGELOG.md

@@ -1,3 +1,25 @@
+# v0.6.0 - 2024-02-09
+
+## Breaking changes
+
+* The default configuration file and custom themes paths have been changed in Windows and macOS to be compliant to where 
+  those platforms store these types of files. See the [configuration 
+  guide](https://mfontanini.github.io/presenterm/guides/configuration.html) to learn more.
+
+## New features
+
+* Add `f` keys, tab, and backspace as possible bindings (#188).
+* Add support for multiline block quotes (#184).
+* Use theme color as background on ascii-blocks mode images (#182).
+* Blend ascii-blocks image semi-transparent borders (#185).
+* Respect Windows/macOS config paths for configuration (#181).
+* Allow making front matter strict parsing optional (#190).
+
+## Fixes
+
+* Don't add an extra line after an end slide shorthand (#187).
+* Don't clear input state on key release event (#183).
+
 # v0.5.0 - 2024-01-26
 
 ## New features

Cargo.toml

@@ -4,7 +4,7 @@ authors = ["Matias Fontanini"]
 description = "A terminal slideshow presentation tool"
 repository = "https://github.com/mfontanini/presenterm"
 license = "BSD-2-Clause"
-version = "0.5.0"
+version = "0.6.0"
 edition = "2021"
 
 [dependencies]

docs/src/guides/basics.md

@@ -195,9 +195,8 @@ Besides this:
 
 ### Configuring key bindings
 
-If you don't like the default key bindings, you can configure them in `~/.config/presenterm/config.yaml`. See the 
-[configuration page](configuration.html#key-bindings) for more information.
-
+If you don't like the default key bindings, you can override them in the [configuration 
+file](configuration.html#key-bindings).
 
 ## Modals
 

docs/src/guides/configuration.md

@@ -1,8 +1,15 @@
 ## Configuration
 
-_presenterm_ currently supports a limited number of configuration parameters that let you customize its behavior. The 
-configuration file is looked up at `$HOME/.config/presenterm/config.yaml` and is not created automatically so you will 
-need to do so if you want to customize any behavior.
+_presenterm_ allows you to customize its behavior via a configuration file. This file is stored, along with all of your 
+custom themes, in the following directories:
+
+* `~/.config/presenterm/` in Linux.
+* `~/Library/Application Support/presenterm/` in macOS.
+* `~/AppData/Roaming/presenterm/config/` in Windows.
+
+The configuration file will be looked up automatically in the directories above under the name `config.yaml`. e.g. on 
+Linux you should create it under `~/.config/presenterm/config.yaml`. You can also specify a custom path to this file 
+when running _presenterm_ via the `--config-path` parameter.
 
 A [sample configuration file](https://github.com/mfontanini/presenterm/blob/master/config.sample.yaml) is provided in 
 the repository that you can use as a base.
@@ -21,11 +28,10 @@ The supported configuration options are currently the following:
 This option removes the need to use `<!-- end_slide -->` in between slides and instead assumes that if you use a slide 
 title, then you're implying that the previous slide ended. For example, the following presentation:
 
-```markdown
+```
 ---
 options:
   implicit_slide_ends: true
-
 ---
 
 Tasty vegetables
@@ -60,11 +66,10 @@ Awful vegetables
 This option allows using thematic breaks (`---`) as a delimiter between slides. When enabling this option, you can still 
 use `<!-- end_slide -->` but any thematic break will also be considered a slide terminator.
 
-```markdown
+```
 ---
 options:
   end_slide_shorthand: true
-
 ---
 
 this is a slide
@@ -91,11 +96,10 @@ considered a command.
 
 For example:
 
-```markdown
+```
 ---
 options:
   command_prefix: "cmd:"
-
 ---
 
 <!-- remember to say "potato here" -->
@@ -118,11 +122,10 @@ because it does.
 If you'd like all bullet points in all lists to show up with pauses in between you can enable the `incremental_lists` 
 option:
 
-```markdown
+```
 ---
 options:
   incremental_lists: true
-
 ---
 
 * pauses
@@ -133,6 +136,20 @@ options:
 Keep in mind if you only want specific bullet points to show up with pauses in between, you can use the 
 [`incremental_lists` comment command](basics.html#incremental-lists).
 
+### strict_front_matter_parsing
+
+This option tells _presenterm_ you don't care about extra parameters in presentation's front matter. This can be useful 
+if you're trying to load a presentation made for another tool. The following presentation would only be successfully 
+loaded if you set `strict_front_matter_parsing` to `false` in your configuration file:
+
+```markdown
+---
+potato: 42
+---
+
+# Hi
+```
+
 ## Defaults
 
 Defaults **can only be configured via the configuration file**.

docs/src/guides/installation.md

@@ -1,6 +1,6 @@
 ## Installation
 
-_presenterm_ works on linux, macOS, and Windows and can be installed in different ways:
+_presenterm_ works on Linux, macOS, and Windows and can be installed in different ways:
 
 ### Pre-built binaries (recommended)
 

docs/src/guides/latex.md

@@ -28,7 +28,7 @@ generated on the fly will have a fixed size. Configuring the PPI used during the
 higher the PPI, the larger the generated images will be.
 
 Because as opposed to most configurations this is a very environment-specific config, the PPI parameter is not part of 
-the theme definition but is instead has to be set in _presenterm_'s config file in `~/.config/presenterm/config.yaml`:
+the theme definition but is instead has to be set in [_presenterm_'s config file](configuration.html):
 
 ```yaml
 typst:

docs/src/guides/themes.md

@@ -75,9 +75,10 @@ Currently, the following themes are supported:
 
 ## Loading custom themes
 
-On startup, _presenterm_ will look into the `~/.config/presenterm/themes` directory and will load any `.yaml` file as a 
-theme and make it available as if it was a built-in theme. This means you can use it as an argument to the `--theme` 
-parameter, use it in the `theme.name` property in a presentation's front matter, etc.
+On startup, _presenterm_ will look into the `themes` directory under the [configuration directory](configuration.html) 
+(e.g. `~/.config/presenterm/themes` in Linux) and will load any `.yaml` file as a theme and make it available as if it 
+was a built-in theme. This means you can use it as an argument to the `--theme` parameter, use it in the `theme.name` 
+property in a presentation's front matter, etc.
 
 ## Theme definition
 
@@ -305,8 +306,9 @@ code:
 
 #### Custom highlighting themes
 
-Besides the built-in highlighting themes, you can drop any `.tmTheme` theme in 
-`~/.config/presenterm/themes/highlighting` and they will be loaded automatically when _presenterm_ starts.
+Besides the built-in highlighting themes, you can drop any `.tmTheme` theme in the `themes/highlighting` directory under 
+your [configuration directory](configuration.html) (e.g. `~/.config/presenterm/themes/highlighting` in Linux) and they 
+will be loaded automatically when _presenterm_ starts.
 
 ### Block quotes
 

src/presentation.rs

@@ -376,6 +376,7 @@ pub(crate) trait ChunkMutator: Debug {
     fn mutate_previous(&self) -> bool;
     fn reset_mutations(&self);
     fn apply_all_mutations(&self);
+    #[allow(dead_code)]
     fn mutations(&self) -> (usize, usize);
 }