Skip to content

Commit

Permalink
docs: update README to 0.3.3
Browse files Browse the repository at this point in the history
  • Loading branch information
OrangeX4 committed Mar 26, 2024
1 parent 7b09ec3 commit 384f94a
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 61 deletions.
24 changes: 6 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,13 @@ Before you begin, make sure you have installed the Typst environment. If not, yo
To use Touying, you only need to include the following code in your document:

```typst
#import "@preview/touying:0.3.2": *
#import "@preview/touying:0.3.3": *
#let s = themes.simple.register(aspect-ratio: "16-9")
#let (init, slides) = utils.methods(s)
#show: init
#let (slide,) = utils.slides(s)
#let (slide, empty-slide) = utils.slides(s)
#show: slides
Expand All @@ -95,15 +95,13 @@ It's simple. Congratulations on creating your first Touying slide! 🎉

**Tip:** You can use Typst syntax like `#import "config.typ": *` or `#include "content.typ"` to implement Touying's multi-file architecture.

**Warning:** The comma in `#let (slide,) = utils.slides(s)` is necessary for the unpacking syntax.


## More Complex Examples

In fact, Touying provides various styles for writing slides. For example, the above example uses first-level and second-level titles to create new slides. However, you can also use the `#slide[..]` format to access more powerful features provided by Touying.

```typst
#import "@preview/touying:0.3.2": *
#import "@preview/touying:0.3.3": *
#import "@preview/cetz:0.2.1"
#import "@preview/fletcher:0.4.2" as fletcher: node, edge
Expand All @@ -112,8 +110,7 @@ In fact, Touying provides various styles for writing slides. For example, the ab
#let fletcher-diagram = touying-reducer.with(reduce: (arr, ..args) => fletcher.diagram(..args, ..arr))
// Register university theme
// You can remove the theme registration or replace other themes
// it can still work normally
// You can also use other themes
#let s = themes.university.register(aspect-ratio: "16-9")
// Global information configuration
Expand All @@ -130,10 +127,11 @@ In fact, Touying provides various styles for writing slides. For example, the ab
#let (init, slides, touying-outline, alert) = utils.methods(s)
#show: init
// Place global settings here
#show strong: alert
// Extract slide functions
#let (slide,) = utils.slides(s)
#let (slide, empty-slide) = utils.slides(s)
#show: slides
= Animation
Expand Down Expand Up @@ -245,16 +243,6 @@ In fact, Touying provides various styles for writing slides. For example, the ab
]
== Setting
#slide(setting: body => {
set text(fill: blue)
body
})[
This slide has blue text.
]
== Multiple Pages
#slide[
Expand Down
8 changes: 8 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ sidebar_position: 14

# Changelog

## v0.3.3

- **template:** move template to `touying-aqua` package, make Touying searchable in [Typst Universe Packages](https://typst.app/universe/search?kind=packages)
- **themes:** fix bugs in university and dewdrop theme
- **feat:** make set-show rule work without `setting` parameter
- **feat:** make `composer` parameter more simpler
- **feat:** add `empty-slide` function

## v0.3.2

- **fix critical bug:** fix `is-sequence` function, make `grid` and `table` work correctly in touying
Expand Down
10 changes: 0 additions & 10 deletions examples/example.typ
Original file line number Diff line number Diff line change
Expand Up @@ -158,16 +158,6 @@
]


== Setting

#slide(setting: body => {
set text(fill: blue)
body
})[
This slide has blue text.
]


== Multiple Pages

#slide[
Expand Down
26 changes: 0 additions & 26 deletions template/main.typ

This file was deleted.

Binary file removed thumbnail.png
Binary file not shown.
9 changes: 2 additions & 7 deletions typst.toml
Original file line number Diff line number Diff line change
@@ -1,16 +1,11 @@
[package]
name = "touying"
version = "0.3.2"
version = "0.3.3"
entrypoint = "lib.typ"
authors = ["OrangeX4", "Andreas Kröpelin", "ntjess", "Enivex", "Pol Dellaiera", "pride7"]
license = "MIT"
description = "A powerful package for creating presentation slides in Typst."
repository = "https://github.com/touying-typ/touying"
keywords = ["presentation", "slides", "lecture", "touying"]
categories = ["presentation"]
exclude = ["examples"]

[template]
path = "template"
entrypoint = "main.typ"
thumbnail = "thumbnail.png"
exclude = ["examples"]

0 comments on commit 384f94a

Please sign in to comment.