use-tabler-icons:0.8.0

packages/preview/use-tabler-icons/0.8.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 zyf722
+
+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/use-tabler-icons/0.8.0/README.md

@@ -0,0 +1,57 @@
+> **Note**
+>
+> This project is greatly inspired by and mainly edited based on [typst-fontawesome](https://github.com/duskmoon314/typst-fontawesome).
+
+<h2 align="center">
+  <img alt="use-tabler-icons" src="assets/splash.svg">
+</h2>
+
+A Typst library for [Tabler Icons](https://github.com/tabler/tabler-icons), a set of over 5700 free MIT-licensed high-quality SVG icons.
+
+## Usage
+### Install Font
+Download [latest release of tabler-icons](https://github.com/tabler/tabler-icons/releases) and install `webfont/fonts/tabler-icons.ttf`. Or, if you are using Typst web app, simply upload the font file to your project.
+
+### Import the Library
+#### Using the Typst Packages
+You can install the library using the typst packages:
+```typst
+#import "@preview/use-tabler-icons:0.8.0": *
+```
+
+#### Manually Install
+Just copy all files under [`src`](https://github.com/zyf722/typst-tabler-icons/tree/main/src) to your project and rename them to avoid naming conflicts.
+
+Then, import `lib.typ` to use the library:
+```typst
+#import "lib.typ": *
+```
+
+### Use the Icons
+You can use the `tabler-icon` function to create an icon with its name:
+```typst
+#tabler-icon("calendar")
+```
+
+Or you can directly use the `ti-` prefix :
+```typst
+#ti-calendar()
+```
+
+As these icons are actually text with custom font, you can pass any text attributes to the function:
+```typst
+#tabler-icon("calendar", fill: blue)
+```
+
+Refer to [`gallery.pdf`](https://github.com/zyf722/typst-tabler-icons/tree/main/gallery/gallery.pdf) and [Tabler Icons website](https://tabler.io/icons) for all available icons.
+
+## Contributing
+[Pull Requests](https://github.com/zyf722/typst-tabler-icons/pulls) are welcome!
+
+It is strongly recommended to follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification when writing commit messages and creating pull requests.
+
+### Github Actions Workflow
+This package uses a daily run [Github Actions workflow](https://github.com/zyf722/typst-tabler-icons/tree/main/.github/workflows/build.yml) to keep the library up-to-date with the latest version of Tabler Icons, which internally runs [`scripts/generate.mjs`](https://github.com/zyf722/typst-tabler-icons/tree/main/scripts/generate.mjs) to generate Typst source code of the library and gallery.
+
+## License
+[MIT](https://github.com/zyf722/typst-tabler-icons/tree/main/LICENSE)