Skip to content

Commit

Permalink
Change typst2anki to typ2anki
Browse files Browse the repository at this point in the history
  • Loading branch information
sgomezsal committed Dec 30, 2024
1 parent 6369e05 commit 67fb28c
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
18 changes: 9 additions & 9 deletions packages/preview/typ2anki/0.1.0/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Typst2Anki
# Typ2Anki

**Typst2Anki** is a Typst package designed to create flashcards seamlessly within Typst-based notes. This package enables users to structure flashcards directly in their documents for easy integration with study and review workflows.
**Typ2Anki** is a Typst package designed to create flashcards seamlessly within Typst-based notes. This package enables users to structure flashcards directly in their documents for easy integration with study and review workflows.

- Create customizable flashcards using Typst syntax.
- Supports structured note-taking with consistent flashcard styling.
Expand Down Expand Up @@ -37,14 +37,14 @@

### Complete Integration

To fully utilize Typst2Anki, ensure you follow the installation instructions for the Python package available at [https://github.com/sgomezsal/typst2anki](https://github.com/sgomezsal/typst2anki).
To fully utilize Typ2Anki, ensure you follow the installation instructions for the Python package available at [https://github.com/sgomezsal/typ2anki](https://github.com/sgomezsal/typ2anki).

### Installing the Typst Package

1. Add the Typst2Anki package to your Typst document:
1. Add the Typ2Anki package to your Typst document:

```typst
#import "@preview/typst2anki:0.1.0"
#import "@preview/typ2anki:0.1.0"
```

2. Place your custom configuration file (`ankiconf.typ`) in the project directory for consistent flashcard rendering.
Expand All @@ -67,11 +67,11 @@ To fully utilize Typst2Anki, ensure you follow the installation instructions for

### Examples

For detailed examples, visit the [examples folder](https://github.com/sgomezsal/typst2anki/tree/main/examples) in the original repository.
For detailed examples, visit the [examples folder](https://github.com/sgomezsal/typ2anki/tree/main/examples) in the original repository.

### Important Note

For full functionality, this Typst package requires the complementary Python package. Installation and usage instructions can be found at [https://github.com/sgomezsal/typst2anki](https://github.com/sgomezsal/typst2anki).
For full functionality, this Typst package requires the complementary Python package. Installation and usage instructions can be found at [https://github.com/sgomezsal/typ2anki](https://github.com/sgomezsal/typ2anki).

### Basic Workflow

Expand Down Expand Up @@ -109,7 +109,7 @@ For full functionality, this Typst package requires the complementary Python pac
To modify card appearance, you can define custom card logic:

```typst
#let custom_card(
#let custom-card(
id: "",
Q: "",
A: "",
Expand All @@ -120,7 +120,7 @@ To modify card appearance, you can define custom card logic:
Q: Q,
A: A,
container: true,
show_labels: true
show-labels: true
)
}
```
Expand Down
Binary file removed packages/preview/typ2anki/0.1.0/src/lib.pdf
Binary file not shown.
2 changes: 1 addition & 1 deletion packages/preview/typ2anki/0.1.0/typst.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ entrypoint = "src/lib.typ"
authors = ["sgomezsal <[email protected]>"]
license = "MIT"
description = "Convert Typst files into Anki cards automatically."
repository = "https://github.com/sgomezsal/typst2anki"
repository = "https://github.com/sgomezsal/typ2anki"
keywords = ["anki", "flashcards", "typst", "automation"]
categories = ["integration", "utility"]
compiler = "0.12.0"

0 comments on commit 67fb28c

Please sign in to comment.