diff --git a/README.md b/README.md index e16e63f..d546889 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Polylux +# Polylux This is a package for creating presentation slides in [Typst](https://typst.app/). [![Book badge](https://img.shields.io/badge/docs-book-green)](https://andreaskroepelin.github.io/polylux/book) @@ -43,7 +43,7 @@ For the bare-bones, do-it-yourself experience, all you need is: ] ``` This code produces these PDF pages: -![minimal example](assets/minimal.png) +![minimal example](https://andreaskroepelin.github.io/polylux/book/minimal.png) From there, you can either start creatively adapting the looks to your likings or you can use one of the provided themes. @@ -97,16 +97,18 @@ It is still very unintrusive but gives you some sensible defaults: ] ``` This time, we obtain these PDF pages: -![simple example](assets/simple.png) +![simple example](https://andreaskroepelin.github.io/polylux/book/themes/gallery/simple.png) As you can see, a theme can introduce its own types of slides (here: `title-slide`, `slide`, `focus-slide`, `centered-slide`) to let you quickly switch between different layouts. -The book (**TODO**) has more infos on how to use (and create your own) themes. +The book +[has more infos](https://andreaskroepelin.github.io/polylux/book/themes/themes.html) +on how to use (and create your own) themes. For dynamic content, polylux also provides [a convenient API for complex -overlays](https://andreaskroepelin.github.io/polylux/book/dynamic.html). +overlays](https://andreaskroepelin.github.io/polylux/book/dynamic/dynamic.html). Visit the [book](https://andreaskroepelin.github.io/polylux/book) diff --git a/book/src/logo.png b/book/src/logo.png new file mode 100644 index 0000000..a427ac5 Binary files /dev/null and b/book/src/logo.png differ diff --git a/book/src/minimal.png b/book/src/minimal.png new file mode 100644 index 0000000..9929192 Binary files /dev/null and b/book/src/minimal.png differ diff --git a/book/src/themes/gallery/clean.png b/book/src/themes/gallery/clean.png index b026a55..ef425af 100644 Binary files a/book/src/themes/gallery/clean.png and b/book/src/themes/gallery/clean.png differ diff --git a/scripts/generate-previews.jl b/scripts/generate-previews.jl index 7fbe148..84b7f0b 100644 --- a/scripts/generate-previews.jl +++ b/scripts/generate-previews.jl @@ -113,7 +113,7 @@ gallery = joinpath(themes, "gallery") # ╔═╡ aa8102d8-029f-4a94-bce4-a7f362b64e4c generate_previews([ - (input = "examples/minimal.typ", output = "assets/minimal.png", label = :none), + (input = "examples/minimal.typ", output = "book/src/minimal.png", label = :none), typ2png(path = diy, file = "hello-world"), typ2png(path = diy, file = "title-slide"), typ2png(path = diy, file = "slide-title"),