Skip to content

Commit

Permalink
docs: update documentation for v0.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
ljgago committed Oct 31, 2024
1 parent 281beb9 commit 2650fd9
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ With `chordx` you can easily generate song lyrics with chords for writing songbo
Typst added an experimental package repository and you can import `chordx` as follows:

```typ
#import "@preview/chordx:0.4.0": *
#import "@preview/chordx:0.5.0": *
```

### Local Packages
Expand All @@ -47,13 +47,13 @@ You can read the documentation about typst [local-packages](https://github.com/t
In Linux you can do:

```sh
git clone https://github.com/ljgago/typst-chords ~/.local/share/typst/packages/local/chordx/0.4.0
git clone https://github.com/ljgago/typst-chords ~/.local/share/typst/packages/local/chordx/0.5.0
```

And import the package in your file:

```typ
#import "@local/chordx:0.4.0": *
#import "@local/chordx:0.5.0": *
```

## Documentation
Expand All @@ -65,7 +65,7 @@ Here [chordx-docs](docs/chordx-docs.pdf) you have the reference documentation th
### Chart Chords

```typ
#import "@preview/chordx:0.4.0": *
#import "@preview/chordx:0.5.0": chart-chord
#let chart-chord-sharp = chart-chord.with(size: 18pt)
#let chart-chord-round = chart-chord.with(size: 1.5em, design: "round")
Expand Down Expand Up @@ -96,7 +96,7 @@ Here [chordx-docs](docs/chordx-docs.pdf) you have the reference documentation th
### Piano Chords

```typ
#import "@preview/chordx:0.4.0": *
#import "@preview/chordx:0.5.0": piano-chord
#let piano-chord-sharp = piano-chord.with(layout: "F", size: 18pt)
#let piano-chord-round = piano-chord.with(layout: "F", size: 1.5em, design: "round")
Expand All @@ -119,7 +119,7 @@ Here [chordx-docs](docs/chordx-docs.pdf) you have the reference documentation th
### Single Chords

```typ
#import "@preview/chordx:0.4.0": *
#import "@preview/chordx:0.5.0": single-chord
#let chord = single-chord.with(
font: "PT Sans",
Expand Down
Binary file modified docs/chordx-docs.pdf
Binary file not shown.
8 changes: 4 additions & 4 deletions docs/chordx-docs.typ
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
authors: (
"Leonardo Javier Gago",
),
date: "July 9, 2024",
date: "October 31, 2024",
version: toml("../typst.toml").package.version,
url: "https://github.com/ljgago/typst-chords"
)
Expand Down Expand Up @@ -41,7 +41,7 @@
==== Example:

```typ-lang
#import "@preview/chordx:0.4.0": *
#import "@preview/chordx:0.5.0": chart-chord
#let chart-chord-sharp = chart-chord.with(size: 18pt)
#let chart-chord-round = chart-chord.with(size: 18pt, design: "round")
Expand Down Expand Up @@ -92,7 +92,7 @@
==== Example:

```typ-lang
#import "@preview/chordx:0.4.0": *
#import "@preview/chordx:0.5.0": piano-chord
#let piano-chord-sharp = piano-chord.with(layout: "F", size: 18pt)
#let piano-chord-round = piano-chord.with(layout: "F", size: 18pt, design: "round")
Expand Down Expand Up @@ -131,7 +131,7 @@
==== Example:

```typ-lang
#import "@preview/chordx:0.4.0": *
#import "@preview/chordx:0.5.0": single-chord
#let chord = single-chord.with(
font: "PT Sans",
Expand Down
4 changes: 2 additions & 2 deletions typst.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[package]
name = "chordx"
version = "0.4.0"
version = "0.5.0"
entrypoint = "lib.typ"
authors = ["Leonardo Gago <https://github.com/ljgago>"]
license = "MIT"
compiler = "0.11.0"
compiler = "0.12.0"
description = "A package to write song lyrics with chord diagrams in Typst."
repository = "https://github.com/ljgago/typst-chords"
keywords = ["chord", "chords", "guitar", "lyrics", "music", "piano", "song", "strings", "tab"]

0 comments on commit 2650fd9

Please sign in to comment.