diff --git a/README.md b/README.md index 373f44e..02a09e2 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,11 @@ While quite basic, this command can be used in conjunction with other tools to q Renders the nearest changelog right inside your terminal using [charmbracelet/glamour](https://github.com/charmbracelet/glamour). + + + + + > Since keepac uses `glamour` to render markdown, you can theme its output by setting the `GLAMOUR_STYLE` environment variable to one of the [available styles](https://github.com/charmbracelet/glamour/tree/master/styles/gallery) or [create your own](https://github.com/charmbracelet/glamour/tree/master/styles). #### `changelog search` diff --git a/tapes/.gitignore b/tapes/.gitignore index 7c06303..0582d64 100644 --- a/tapes/.gitignore +++ b/tapes/.gitignore @@ -1,2 +1,3 @@ *.gif *.md +!examples/*.md diff --git a/tapes/dark/demo.tape b/tapes/dark/demo.tape index b5bbcdd..3567066 100644 --- a/tapes/dark/demo.tape +++ b/tapes/dark/demo.tape @@ -1,4 +1,4 @@ -Require changelog +Source ../partials/config.tape Type "changelog find" Enter diff --git a/tapes/dark/insert.tape b/tapes/dark/insert.tape index df16fe1..5e4758a 100644 --- a/tapes/dark/insert.tape +++ b/tapes/dark/insert.tape @@ -1,4 +1,4 @@ -Require changelog +Source ../config.tape Hide # Create new file diff --git a/tapes/dark/search.tape b/tapes/dark/search.tape index 53e62e7..7e5ff70 100644 --- a/tapes/dark/search.tape +++ b/tapes/dark/search.tape @@ -1,7 +1,7 @@ -Require changelog +Source ../partials/config.tape Require wget -Set Width 2400 +Set Width 1500 Set Height 800 Hide diff --git a/tapes/dark/show.tape b/tapes/dark/show.tape new file mode 100644 index 0000000..792f511 --- /dev/null +++ b/tapes/dark/show.tape @@ -0,0 +1,12 @@ +Source ../partials/config.tape + +Hide +Type "cp ../examples/markdown.md ./CHANGELOG.md" +Enter +Sleep 250ms +Show + + + +Hide +Type "rm CHANGELOG.md" diff --git a/tapes/examples/markdown.md b/tapes/examples/markdown.md new file mode 100644 index 0000000..334eb1c --- /dev/null +++ b/tapes/examples/markdown.md @@ -0,0 +1,36 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The changes describe a contrived project to demonstrate the markdown output of `keepac` / `changelog`. + +## [Unreleased] + +### Changed + +- A **whole new** way of doing the thing + +## [1.1.0] - 2022-04-04 + +> This release is sponsored by [our GitHub sponsors](https://github.com/sponsors/NiclasvanEyk) ❤️ + +### Added + +- A new cool syntax highlighter: + ```rs + // Inline code snippets! + let foo = "bar" + ``` + +## [1.0.1] - 2022-02-03 + +### Fixed + +- A _nasty_ bug when calling `foo` without previously calling `bar` +- A complicated deadlock which is better explained in [#123](https://github.com/NiclasvanEyk/keepac/pull/123) + +## [1.0.0] - 2022-02-02 + +### Added + +- The initial version of the thing diff --git a/tapes/partials/config.tape b/tapes/partials/config.tape new file mode 100644 index 0000000..de2ab56 --- /dev/null +++ b/tapes/partials/config.tape @@ -0,0 +1,4 @@ +# This tape just houses shared configuration and is included/sourced into all +# other tapes + +Require changelog