Skip to content

[docs] fixes #94

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

Merged
Mc-Zen merged 2 commits into from
Jul 6, 2026
Merged

[docs] fixes #94

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c92f7c
[docs] fixes
Mc-Zen Jul 6, 2026
e40ff84
Update images in README for light and dark modes
Mc-Zen Jul 6, 2026
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: 10 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ See below for a few examples of the syntax that can be used with `num`.

<p align="center">
<picture>
<source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/925fb0ff-5af2-4373-a3e6-63f23523d60c">
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/3cd8948a-d0cb-4b77-bd12-9b582abed46d">
<img alt="Quick demo" src="https://github.com/user-attachments/assets/925fb0ff-5af2-4373-a3e6-63f23523d60c">
<source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/1331bf62-530d-423e-9052-2483cb641718">
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/eebc2676-ad22-4a97-a21b-09517251f14e">
<img alt="num syntax overview" src="https://github.com/user-attachments/assets/1331bf62-530d-423e-9052-2483cb641718">
</picture>
</p>

Expand Down Expand Up @@ -351,12 +351,11 @@ Zero not only aligns numbers at the decimal point but also at the uncertainty an

<p align="center">
<picture>
<source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/0d707e0c-2231-4c0c-afd5-97f6bdf7fca0">
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/ee5c1734-93ff-4cce-a59d-2d4f8b7d66f7">
<img alt="Advanced number alignment in tables" src="https://github.com/user-attachments/assets/0d707e0c-2231-4c0c-afd5-97f6bdf7fca0">
<source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/f91004fe-d7ca-4db8-81a1-b65236c72cac">
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/e1c8abfe-b59c-4789-a356-df2e545a99c5">
<img alt="Advanced number alignment in tables" src="https://github.com/user-attachments/assets/f91004fe-d7ca-4db8-81a1-b65236c72cac">
</picture>
</p>

---

## Units and Quantities
Expand All @@ -373,16 +372,16 @@ Take a look at the example below:

#let kgm-s2 = zi.declare("kg m/s^2")

- The current world record for the 100 metres is held by Usain Bolt with #zi.s[9.58].
- The current world record for the 100 meters is held by Usain Bolt with #zi.s[9.58].
- The velocity of light is #zi.m-s[299792458].
- A Newton is defined as #kgm-s2[1].
- The unit of a frequency is #zi.Hz().
```
<p align="center">
<picture>
<source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/566500e3-7e4f-44eb-ae2e-b527084703bc">
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/316ed789-8777-4ff1-b885-9f079bb4b10c">
<img alt="Units and quantities" src="https://github.com/user-attachments/assets/566500e3-7e4f-44eb-ae2e-b527084703bc">
<source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/45597707-323a-4cc2-b331-07daf5ec64c4">
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/06768121-e130-40e6-87b3-14a3f1f0372d">
<img alt="Units and quantities" src="https://github.com/user-attachments/assets/45597707-323a-4cc2-b331-07daf5ec64c4">
</picture>
</p>

Expand Down
2 changes: 1 addition & 1 deletion docs/figures/quick-demo.typ
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

#let examples = (
`num("1.2e4")` ,`num[1.2e4]`,
`num("-5e-4")` ,`num(fixed: -2)[0.02]`,
`num("-5e-4")` ,`num(exponent: (fixed: -2))[0.02]`,
`num("9.81+-.01")` ,`num("9.81+0.02-.01")`,
`num("9.81+-.01e2")` ,`num(base: 2)[3e4]`,
)
Expand Down
2 changes: 1 addition & 1 deletion docs/figures/table.typ
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
[2], [4.568e1], [-0.1+-1e4], [1.23],
[3], [12.2e4], [-.02+-.02], [1],
[...], [24.1e6], [-1.1+-5], [9.1],
[10], [234e200], [-0.00234+-.3e3], [1.1]
[10], [234e200], [-0.00234+-.0003e3], [1.1]
)

#table1
Expand Down
2 changes: 1 addition & 1 deletion docs/figures/unit-demo.typ
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

#let kgm-s2 = zi.declare("kg m/s^2")

- The current world record for the 100 metres is #zi.s[9.58], held by Usain Bolt.
- The current world record for the 100 meters is #zi.s[9.58], held by Usain Bolt.
- The velocity of light is #zi.m-s[299792458].
- A Newton is defined as #kgm-s2[1].
- The unit of a frequency is #zi.Hz().
Loading