-
Notifications
You must be signed in to change notification settings - Fork 0
/
example.yml
28 lines (27 loc) · 1.34 KB
/
example.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
## yaml-language-server: $schema=https://raw.githubusercontent.com/jskherman/cv.typ/main/cv.typ.schema.json
title: How to Use `share.typ` 📝
author: "@mangkoran"
abstract: >
With `share.typ`, you can quickly create beautiful short writings to share in
social media thanks to Typst simple yet powerful syntax. Below are the steps
to start creating awesome post using `share.typ`:
items:
- title: Add mangkoran/share.typ as git submodule
description: >
By adding `share.typ` repo as git submodule, any upstream changes can be
pulled easily. You can modify several style variables and even override
existing function implementations to your heart's content.
- title: Copy example files to repo root directory
description: >
Copy (and rename if you want) `example.typ` and `example.yml` to your repo
root directory. For post YAML file you can create a new directory (`post`
or else) for better organization. Don't forget to update the YAML import
to reflect this. Use these files as template/starting point for your post.
- title: Compile content file
description: >
Typst compiles to PDF by default. To compile Typst to PNG, use `typst
compile <your-post-content>.typ <output>.png`.
- title: Share in social media
description: >
Also let your followers know that the post was made using Typst (and
`share.typ`) 😁