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.

Sign up for GitHub

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

fix: various minor updates #33

Merged
merged 3 commits into from
Jul 18, 2024
Merged

fix: various minor updates #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2b4ff6a
docs: remove badges
yunanwg Jul 18, 2024
d219bcf
github: update deploy-docs condition
yunanwg Jul 18, 2024
aff7936
docs: update README (#31)
yunanwg Jul 18, 2024
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
2 changes: 2 additions & 0 deletions .github/workflows/deploy-docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ name: Deploy Documentation

on:
push:
branches:
- main
workflow_dispatch:

jobs:
Expand Down
9 changes: 3 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@
Brilliant CV
</h1>

<p align="center">
<img alt="Typst Version" src="https://img.shields.io/badge/Minimal Compatible Typst Version-0.11.0-blue"/>
<img alt="Read Documentation" src="https://img.shields.io/badge/Read-Documentation-yellow?link=https://mintyfrankie.github.io/brilliant-CV/docs.pdf">
</p>

<br>

> If my work helps you drift through tedious job seeking journey, don't hesitate to think about [buying me a Coke Zero](https://github.com/sponsors/mintyfrankie)... or a lot of them! 🥤
Expand Down Expand Up @@ -56,7 +51,9 @@

### 1. Install Fonts

In order to make Typst render correctly, you will have to install the required fonts [**Roboto**](https://fonts.google.com/specimen/Roboto) and [**Source Sans Pro**](https://fonts.google.com/specimen/Source+Sans+3) (or **Source Sans 3**) in your local system.
In order to make Typst render correctly, you will have to install the required fonts [**Roboto**](https://fonts.google.com/specimen/Roboto), [**Source Sans Pro**](https://fonts.google.com/specimen/Source+Sans+3) (or **Source Sans 3**) as well as [Fontawesome 6](https://github.com/typst/webapp-issues/issues/401) in your local system.

*NOTE: For online editor, Roboto and Source Sans Pro are already included; however you will still have to manually upload the `.otf` files of Fontawesome to your project. See [Issue](https://github.com/typst/webapp-issues/issues/401)*

### 2. Check Documentation

Expand Down