Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

socialhub-svg:1.0.0 #467

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions packages/preview/socialhub-svg/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 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.
39 changes: 39 additions & 0 deletions packages/preview/socialhub-svg/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# [Social Media References based on Scalable Vector Graphics (SVG) Icons for Typst](https://github.com/Bi0T1N/typst-socialhub-svg)
The `socialhub-svg` 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.

## Features
- Support for popular social media, developer and career platforms
- Uniform design for all entries
- Based on publicly available SVG symbols
- Easy to use
- Allows the customization of the look (extra args are passed to [`text`](https://typst.app/docs/reference/text/text/))

## Usage
### Using Typst's package manager
You can install the library using the [typst packages](https://github.com/typst/packages):
```typst
#import "@preview/socialhub-svg:1.0.0": *
```

### Install manually
Put the `socialhub-svg.typ` file in your project directory and import it:
```typst
#import "socialhub-svg.typ": *
```

### Minimal Example
```typst
// #import "@preview/socialhub-svg:1.0.0": github-info, gitlab-info
#import "socialhub-svg.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.

## 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.
Binary file not shown.
104 changes: 104 additions & 0 deletions packages/preview/socialhub-svg/examples/examples.typ
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
#import "socialhub-svg.typ": *

= Usage Examples
== Facebook
#facebook-info("NEFFEX", url: "https://www.facebook.com/Neffexmusic/")
#h(1cm)
#facebook-info("NEFFEX", url: "https://www.facebook.com/Neffexmusic", blue)

== Instagram
#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("Floating Finish", url: "https://www.youtube.com/@floatingfinish2211", green)

== Vimeo
#vimeo-info("osrfoundation")
#h(1cm)
#vimeo-info("Open Robotics", url: "https://vimeo.com/osrfoundation/")

== LinkedIn
#linkedin-info("BMW Group", url: "https://www.linkedin.com/company/bmw-group/", rgb("0166B1"))

== XING
#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
#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.
4 changes: 4 additions & 0 deletions packages/preview/socialhub-svg/examples/minimal_example.typ
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
// #import "@preview/socialhub-svg:1.0.0": github-info, gitlab-info
#import "socialhub-svg.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").
Loading
Loading