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

Jump to bottom

Improve documentation a bit #14

Merged
merged 1 commit into from
Oct 25, 2023
Merged

Improve documentation a bit #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ See the [manual](https://github.com/Leedehai/typst-physics/blob/master/physica-m

![demo](https://user-images.githubusercontent.com/18319900/236073825-e91b4601-7e92-490b-a7e4-e9e405a2147b.png)

## Using phyiscs in your Typst document
## Using physica in your Typst document

### With `typst` package management (recommended)

Expand All @@ -42,21 +42,21 @@ See https://github.com/typst/packages.
<img src="https://github.com/Leedehai/typst-physics/assets/18319900/f2a3a2bd-3ef7-4383-ab92-9a71affb4e12" width="173" alt="effect">
</p>

```
```typst
// Style 1
#import "@preview/physica:0.8.0": *

$ curl (grad f), tensor(T, -mu, +nu), pdv(f,x,y,[1,2]) $
```

```
```typst
// Style 2
#import "@preview/physica:0.8.0": curl, grad, tensor, pdv

$ curl (grad f), tensor(T, -mu, +nu), pdv(f,x,y,[1,2]) $
```

```
```typst
// Style 3
#import "@preview/physica:0.8.0"

Expand Down
8 changes: 4 additions & 4 deletions physica-manual.typ
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ With `typst`'s #linkurl("package management", "https://github.com/typst/packages

#import "physica.typ": *

```
```typst
#import "@preview/physica:0.8.0": *

$ curl (grad f), tensor(T, -mu, +nu), pdv(f,x,y,[1,2]) $
Expand Down Expand Up @@ -422,7 +422,7 @@ xmat(2, 2, #g)`)

#v(1em)

Typst built-in math operators: #linkurl("source code", "https://github.com/typst/typst/blob/main/library/src/math/op.rs").
Typst built-in math operators: #linkurl(`math.op`, "https://typst.app/docs/reference/math/op/").

#table(
columns: (auto, auto),
Expand Down Expand Up @@ -877,7 +877,7 @@ Function: `signals(str`, `step:`:..., `style`:...`)`.
[`X` \ $ signals("X") $],
[],

[ingore: (blankspace) \ separate: `&`],
[ignore: (blankspace) \ separate: `&`],
[repeat: `.` (dot)],
)

Expand All @@ -896,7 +896,7 @@ $ signals("-|=|-", step: #2em), signals("-|#|-"), signals("-<=>-<=") $
$ signals("R1..F0..", step: #.5em)signals("R1.|v|1", step: #.5em, color:#fuchsia) $

*(5)*
```
```typst
"clk:" & signals("|1....|0....|1....|0....|1....|0....|1....|0..", step: #0.5em) \
"bus:" & signals(" #.... X=... ..... ..... X=... ..... ..... X#.", step: #0.5em)
```
Expand Down
Loading