Skip to content

Commit ed068a2

Browse files
Initial commit
0 parents  commit ed068a2

17 files changed

+433
-0
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 polylux-typ
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
![Polylux logo](https://raw.githubusercontent.com/polylux-typ/polylux/ed1e70e74f2a525e80ace9144249c9537917731c/assets/polylux-logo.svg)
2+
3+
# Friendly
4+
5+
A friendly and playful template for creating presentation slides with Typst and
6+
[Polylux](https://github.com/polylux-typ/polylux/).
7+
8+
![thumbnail](thumbnail.png)
9+
10+
11+
Use via
12+
```sh
13+
typst init @preview/friendly-polylux your-cool-project
14+
```
15+
16+
A `slides.typ` file will be created for you that you can directly edit to get
17+
going.
18+
19+
At the top of the generated `slides.typ`, you will find
20+
```typ
21+
#show: friendly.setup.with(
22+
// ...
23+
)
24+
```
25+
which you can edit to configure the template
26+
27+
## Fonts
28+
29+
By default, the template uses the fonts
30+
[Andika](https://software.sil.org/andika/download/),
31+
[Fantasque Sans Mono](https://github.com/belluzj/fantasque-sans/releases),
32+
and
33+
[Excalifont](https://plus.excalidraw.com/excalifont).
34+
Either make sure you have them installed or specify other fonts in the template.
35+

friendly.typ

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#import "lib.typ": (
2+
icons,
3+
get-in-touch,
4+
titled-block,
5+
setup,
6+
title-slide,
7+
last-slide,
8+
)

icons/down-arrow.svg

Lines changed: 7 additions & 0 deletions
Loading

icons/email.svg

Lines changed: 5 additions & 0 deletions
Loading

icons/icons.typ

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#let www-white = box(image("www.svg", width: 1em), baseline: .2em)
2+
#let www = box(image("www-black.svg", width: 1em))
3+
#let email = box(image("email.svg", width: 1em))
4+
#let mastodon = box(image("mastodon.svg", width: 1em))
5+
#let down-arrow = box(image("down-arrow.svg", width: 1em))
6+
#let up-arrow = box(image("up-arrow.svg", width: 1em))
7+
#let right-arrow = box(image("right-arrow.svg", width: 1em), baseline: .2em)

icons/logo.svg

Lines changed: 43 additions & 0 deletions
Loading

icons/mastodon.svg

Lines changed: 9 additions & 0 deletions
Loading

icons/right-arrow.svg

Lines changed: 7 additions & 0 deletions
Loading

icons/up-arrow.svg

Lines changed: 10 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)