gentle-clues:1.2.0 (#1782)

Co-authored-by: Ana Gelez <ana+github@gelez.xyz>

packages/preview/gentle-clues/1.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 jomaway
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/preview/gentle-clues/1.2.0/README.md

@@ -0,0 +1,56 @@
+# gentle-clues
+
+Simple admonitions for typst. Add predefined or define your own.
+
+Inspired from [mdbook-admonish](https://tommilligan.github.io/mdbook-admonish/).
+
+## Overview of all predefined clues:
+![Overview of the predefined clues](./gc-overview.svg)
+
+## Usage
+
+For full information, see the [docs.pdf](https://github.com/jomaway/typst-gentle-clues/blob/main/docs.pdf)
+
+To use this package, simply add the following code to your document:
+```typst
+#import "@preview/gentle-clues:1.2.0": *
+
+// add an info clue
+#info[ This is the info clue ... ]
+
+// or a tip with custom title
+#tip(title: "Best tip ever")[Check out this cool package]
+```
+
+_This will create an info clue and tip clue inside your document. See the overview for all available clues.
+
+### Features
+
+This package provides some features which helps to customize the clues to your liking.
+
+- Set global default for all clues
+- Overwrite each parameter on a single clue for changing title, color, etc.
+- Show or hide a counter value on tasks.
+- Define your own clues very easily.
+- ...
+
+For a full list see the [documentation](https://github.com/jomaway/typst-gentle-clues/blob/main/docs.pdf).
+
+## Language support
+
+This package does use [linguify](https://github.com/jomaway/typst-linguify) to support multiple languages.
+
+**Header titles:**
+The language of the header titles is detected automatically from the `context text.lang`.
+See the file [lang.toml](https://github.com/jomaway/typst-gentle-clues/blob/main/lib/lang.toml) for currently supported languages.
+
+If an unsupported language is set it will fallback to english as default.
+Feel free to open a PR with your language added to the `lang.toml` file.
+
+## License
+
+[MIT License](LICENSE)
+
+## Changelog
+
+[See CHANGELOG.md](CHANGELOG.md)