iconic-salmon-fa:1.0.0 #575
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2023 Nico Neumann (Bi0T1N) | ||
|
|
||
| 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| # [Social Media References based on Font Awesome for Typst](https://github.com/Bi0T1N/typst-iconic-salmon-fa) | ||
| The `iconic-salmon-fa` package is designed to help you create your curriculum vitae (CV). It allows you to easily reference your social media profiles with the typical icon of the service plus a link to your profile. | ||
| The package name is a combination of the acronym *SociAL Media icONs* and the word *iconic* because all these icons have an iconic design (and iconic also contains the word *icon*). | ||
|
|
||
| ## Features | ||
| - Support for popular social media, developer and career platforms | ||
| - Uniform design for all entries | ||
| - Based on the Internet's icon library [Font Awesome](https://fontawesome.com/) | ||
| - Easy to use | ||
| - Allows the customization of the look (extra args are passed to [`text`](https://typst.app/docs/reference/text/text/)) | ||
|
|
||
| ## Fonts Installation | ||
| ### Linux | ||
| 1. [Download Font Awesome for Desktop](https://fontawesome.com/download) | ||
| 2. Unzip the file | ||
| 3. Switch into the `otfs` folder within the unzipped folder | ||
| 4. Run `mkdir -p /usr/share/fonts/truetype/` | ||
| 5. Run `install -m644 'Font Awesome 6 Brands-Regular-400.otf' /usr/share/fonts/truetype/` | ||
| 6. Unfortunately not all brands are included in the brands font file, so you must also run `install -m644 'Font Awesome 6 Free-Regular-400.otf' /usr/share/fonts/truetype/` | ||
|
|
||
| ## Usage | ||
| ### Using Typst's package manager | ||
| You can install the library using the [typst packages](https://github.com/typst/packages): | ||
| ```typst | ||
| #import "@preview/iconic-salmon-fa:1.0.0": * | ||
| ``` | ||
|
|
||
| ### Install manually | ||
| Put the `iconic-salmon-fa.typ` file in your project directory and import it: | ||
| ```typst | ||
| #import "iconic-salmon-fa.typ": * | ||
| ``` | ||
|
|
||
| ### Minimal Example | ||
| ```typst | ||
| // #import "@preview/iconic-salmon-fa:1.0.0": github-info, gitlab-info | ||
| #import "iconic-salmon-fa.typ": github-info, gitlab-info | ||
|
|
||
| This project was created by #github-info("Bi0T1N"). You can also find me on #gitlab-info("GitLab", rgb("#811052"), url: "https://gitlab.com/Bi0T1N"). | ||
| ``` | ||
|
|
||
| ### Examples | ||
| See the [`examples.typ`](examples/examples.typ) file for a complete example. The [generated PDF files](examples/) are also available for preview. | ||
|
|
||
| ## Troubleshooting | ||
| ### Icons are not displayed correctly | ||
| Make sure that you have installed the required Font Awesome ligature-based font files. | ||
|
|
||
| ## Contribution | ||
| Feel free to open an issue or a pull request if you find any problems or have any suggestions. | ||
|
|
||
| ## License | ||
| This library is licensed under the MIT license. Feel free to use it in your project. | ||
|
|
||
| ## Trademark Disclaimer | ||
| Product names, logos, brands and other trademarks referred to in this project are the property of their respective trademark holders. | ||
| These trademark holders are not affiliated with this Typst library, nor are the authors officially endorsed by them, nor do the authors claim ownership of these trademarks. |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| #import "../iconic-salmon-fa.typ": * | ||
|
|
||
| = Usage Examples | ||
| #facebook-info("NEFFEX", url: "https://www.facebook.com/Neffexmusic/") | ||
| #h(1cm) | ||
| #facebook-info("NEFFEX", url: "https://www.facebook.com/Neffexmusic", blue) | ||
|
|
||
| #instagram-info("janlo.pulling_pictures") | ||
| #h(0.5cm) | ||
| #instagram-info("janlo.pulling_pictures", purple) | ||
| #h(0.5cm) | ||
| #instagram-info("Jan Lo - Tractor-Pulling Media „Jan Knips“", url: "https://www.instagram.com/janlo.pulling_pictures/") | ||
|
|
||
| == TikTok | ||
| #tiktok-info("neffex", green, style: "italic") | ||
| #h(1cm) | ||
| #tiktok-info("NEFFEX", url: "https://www.tiktok.com/@neffex/", font: "DejaVu Sans") | ||
|
|
||
| == YouTube | ||
| #youtube-info("floatingfinish2211") | ||
| #h(1cm) | ||
| #youtube-info("floatingfinish2211", rgb("#0033cc"), weight: "bold") | ||
| #h(1cm) | ||
| #youtube-info("floatingfinish2211", green) | ||
|
|
||
| == Vimeo | ||
| #vimeo-info("osrfoundation") | ||
| #h(1cm) | ||
| #vimeo-info("Open Robotics", url: "https://vimeo.com/osrfoundation/") | ||
|
|
||
| #linkedin-info("BMW Group", url: "https://www.linkedin.com/company/bmw-group/", rgb("0166B1")) | ||
|
|
||
| #xing-info("CLAAS", url: "https://www.xing.com/pages/claas") | ||
| #h(1cm) | ||
| #xing-info("ABB Deutschland", url: "https://www.xing.com/pages/abbde") | ||
|
|
||
| == GitHub | ||
| #github-info("Bi0T1N") | ||
| #h(1cm) | ||
| #github-info("Bi0T1N", rgb("#ffcc00")) | ||
| #h(1cm) | ||
| #github-info("Bi0T1N", green) | ||
|
|
||
| == GitLab | ||
| #gitlab-info("Bi0T1N") | ||
| #h(1cm) | ||
| #gitlab-info("Bi0T1N", rgb("#811052")) | ||
| #h(1cm) | ||
| #gitlab-info("Bi0T1N", green) | ||
| #h(1cm) | ||
| #gitlab-info("Bi0T1N", url: "https://gitlab.com/Bi0T1N/fpc-docker") | ||
|
|
||
| == Bitbucket | ||
| #bitbucket-info("karaiskc") | ||
| #h(1cm) | ||
| #bitbucket-info("karaiskc", url: "https://bitbucket.org/karaiskc/ros-sensor-info-viewer-and-logger/") | ||
|
|
||
| // == Codeberg | ||
| // #codeberg-info("biotite-dev") | ||
|
|
||
| // == SourceForge | ||
| // #sourceforge-info("Lazarus", url: "https://sourceforge.net/projects/lazarus/") | ||
|
|
||
| == Docker | ||
| #docker-info("rust", url: "https://hub.docker.com/_/rust", rgb("b7410e")) | ||
| #h(1cm) | ||
| #docker-info("Bi0T1N", url: "https://hub.docker.com/u/bi0t1n") | ||
| #h(1cm) | ||
| #docker-info("debian", url: "https://hub.docker.com/_/debian", red) | ||
|
|
||
| == Stack Overflow | ||
| #stackoverflow-info("Remy Lebeau", url: "https://stackoverflow.com/users/65863/remy-lebeau") | ||
| #h(1cm) | ||
| #stackoverflow-info("Bi0T1N", url: "https://stackoverflow.com/users/20742512/bi0t1n", orange) | ||
|
|
||
| == Stack Exchange | ||
| #stackexchange-info("Remy Lebeau", url: "https://scifi.stackexchange.com/users/42754/remy-lebeau") | ||
| #h(1cm) | ||
| #stackexchange-info("Bi0T1N", url: "https://robotics.stackexchange.com/users/33077/bi0t1n") | ||
|
|
||
| == Skype | ||
| #skype-info("callme") | ||
|
|
||
| == Discord | ||
| #discord-info("messageme") | ||
|
|
||
| #twitter-info("elonmusk", rgb("#663300")) | ||
| #h(1cm) | ||
| #twitter-info("Elon Musk", url: "https://twitter.com/elonmusk/", rgb("#663300")) | ||
|
|
||
| == X / Twitter | ||
| #x-twitter-info("elonmusk", rgb("#663300")) | ||
| #h(1cm) | ||
| #x-twitter-info("Elon Musk", url: "https://twitter.com/elonmusk/", rgb("#663300")) | ||
|
|
||
| == ORCID | ||
| #orcid-info("0000-0002-1825-0097") | ||
| #h(1cm) | ||
| #orcid-info("Josiah Carberry", url: "https://orcid.org/0000-0002-1825-0097", green) | ||
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,4 @@ | ||||||
| // #import "@preview/iconic-salmon-fa:1.0.0": github-info, gitlab-info | ||||||
| #import "../iconic-salmon-fa.typ": github-info, gitlab-info | ||||||
|
There was a problem hiding this comment. Same here:
Suggested change
|
||||||
|
|
||||||
| This project was created by #github-info("Bi0T1N"). You can also find me on #gitlab-info("GitLab", rgb("#811052"), url: "https://gitlab.com/Bi0T1N"). | ||||||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This import should use the package specification:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there any hard requirement for this? I see that several other packages also reference the local version (which btw is the only way to access a new version to generate a new PDF file before publishing)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, it is not a hard requirement. It is just better because then people can copy/paste your example and start from here. It also makes it easier to tell which version of the package is used if the file is given out-of-context.
I agree that this is however not ideal to generate PDF files. The best solution as far as I know is to generate them with the relative import, and then update it to use the package import before submitting here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's why I have included the instructions in the
README.md😄There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, I'll merge it as is then.