Merge pull request #59 from andreasKroepelin/prepare-package

Prepare package

README.md

@@ -1,73 +1,127 @@
-# Slides in Typst
-This is a template for creating slides in [Typst](https://typst.app/).
+# Polylux <img src="assets/logo.png" style="width: 3em;"></img>
+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/typst-slides/book)
-![GitHub](https://img.shields.io/github/license/andreasKroepelin/typst-slides)
-![GitHub release (latest by date)](https://img.shields.io/github/v/release/andreasKroepelin/typst-slides)
-[![Demo badge](https://img.shields.io/badge/demo-pdf-blue)](https://github.com/andreasKroepelin/typst-slides/releases/latest/download/demo.pdf)
+[![Book badge](https://img.shields.io/badge/docs-book-green)](https://andreaskroepelin.github.io/polylux/book)
+![GitHub](https://img.shields.io/github/license/andreasKroepelin/polylux)
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/andreasKroepelin/polylux)
+[![Demo badge](https://img.shields.io/badge/demo-pdf-blue)](https://github.com/andreasKroepelin/polylux/releases/latest/download/demo.pdf)
+![Themes badge](https://img.shields.io/badge/themes-5-aqua)
 
 ## Quickstart
+For the bare-bones, do-it-yourself experience, all you need is:
 ```typ
-#import "slides.typ": *
-
-#show: slides.with(
-    authors: "Names of author(s)",
-    short-authors: "Shorter author for slide footer",
-    title: "Title of the presentation",
-    subtitle: "Subtitle of the presentation",
-    short-title: "Shorter title for slide footer",
-    date: "March 2023",
-)
+// Get polylux from the official package repository
+#import "@preview/polylux:0.2.0": *
+
+// Make the paper dimensions fit for a presentation and the text larger
+#set page(paper: "presentation-16-9")
+#set text(size: 25pt)
 
-#set text(font: "Inria Sans", size: 25pt)
+// Use #polylux-slide to create a slide and style it using your favourite Typst functions
+#polylux-slide[
+  #align(horizon + center)[
+    = Very minimalist slides
 
-#slide(theme-variant: "title slide")
+    A lazy author
 
-#new-section("My section name")
+    July 23, 2023
+  ]
+]
 
-#slide(title: "A boring static slide")[
-  Some boring static text.
+#polylux-slide[
+  == First slide
 
-  #lorem(20)
+  Some static text on this slide.
 ]
 
-#slide[
-  A fancy dynamic slide without a title.
-  #uncover("2-")[This appears later!]
+#polylux-slide[
+  == This slide changes!
+
+  You can always see this.
+  // Make use of features like #uncover, #only, and others to create dynamic content
+  #uncover(2)[But this appears later!]
+]
+```
+This code produces these PDF pages:
+![minimal example](assets/minimal.png)
+
+From there, you can either start creatively adapting the looks to your likings
+or you can use one of the provided themes.
+The simplest one of them is called `simple` (what a coincidence!).
+It is still very unintrusive but gives you some sensible defaults:
+```typ
+#import "@preview/polylux:0.2.0": *
+
+#import themes.simple: *
+
+#set text(font: "Inria Sans")
+
+#show: simple-theme.with(
+  footer: [Simple slides],
+)
+
+#title-slide[
+  = Keep it simple!
+  #v(2em)
+
+  Alpha #footnote[Uni Augsburg] #h(1em)
+  Bravo #footnote[Uni Bayreuth] #h(1em)
+  Charlie #footnote[Uni Chemnitz] #h(1em)
+
+  July 23
 ]
 
-#slide(theme-variant: "wake up")[
-  Focus!
+#slide[
+  == First slide
+
+  #lorem(20)
 ]
 
-#new-section("Conclusion")
+#focus-slide[
+  _Focus!_
 
-#slide(title: "Take home message")[
-  Read the book!
+  This is very important.
+]
+
+#centered-slide[
+  = Let's start a new section!
+]
 
-  Try it out!
+#slide[
+  == Dynamic slide
+  Did you know that...
 
-  Create themes!
+  #uncover(2)[
+    ...you can see the current section at the top of the slide?
+  ]
 ]
 ```
-This code produces these PDF pages:
-![title slide](assets/simple.png)
+This time, we obtain these PDF pages:
+![simple example](assets/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.
 
-As you can see, creating slides is as simple as using the `#slide` function.
-You can also use different
-[themes](https://andreaskroepelin.github.io/typst-slides/book/theme-gallery/index.html)
-(contributions welcome if you happen to
-[create your own](https://andreaskroepelin.github.io/typst-slides/book/themes.html#create-your-own-theme)!)
 
-For dynamic content, the template also provides [a convenient API for complex
-overlays](https://andreaskroepelin.github.io/typst-slides/book/dynamic.html).
+For dynamic content, polylux also provides [a convenient API for complex
+overlays](https://andreaskroepelin.github.io/polylux/book/dynamic.html).
 
 Visit the
-[book](https://andreaskroepelin.github.io/typst-slides/book)
+[book](https://andreaskroepelin.github.io/polylux/book)
 for more details or take a look at the
-[demo PDF](https://github.com/andreasKroepelin/typst-slides/releases/latest/download/demo.pdf)
+[demo PDF](https://github.com/andreasKroepelin/polylux/releases/latest/download/demo.pdf)
 where you can see the features of this template in action.
 
-**⚠ This template is in active development.
+**⚠ This package is under active development.
 While I try to make sure that the `main`-branch always is in a usable state,
 there are no compatibility guarantees!**
+
+## Acknowledgements
+Thank you to...
+- [@drupol](https://github.com/drupol) for the `university` theme
+- [@Enivex](https://github.com/Enivex) for the `metropolis` theme
+- [@MarkBlyth](https://github.com/MarkBlyth) for contributing to the `clean` theme
+- [@fncnt](https://github.com/fncnt) for coming up with the name "polylux"
+- the Typst authors and contributors for this refreshing piece of software

book/book.toml

@@ -3,7 +3,11 @@ authors = ["Andreas Kröpelin"]
 language = "en"
 multilingual = false
 src = "src"
-title = "Slides in Typst"
+title = "Polylux"
 
 [output.html]
-site-url = "/typst-slides/book/"
+site-url = "/polylux/book/"
+
+[output.html.code.hidelines]
+typ = "~"
+

book/src/SUMMARY.md

@@ -1,9 +1,25 @@
 # Summary
 
-- [Basics](./basics.md)
-  - [Configuration](./config.md)
-  - [Creating slides](./slide.md)
-  - [Sections](./section.md)
-  - [Dynamic slides](./dynamic.md)
-- [Themes](./themes.md)
-  - [Gallery](./theme-gallery/index.md)
+[Polylux](./polylux.md)
+- [Getting started](./getting-started.md)
+- [Do it yourself](./diy/diy.md)
+- [Dynamic slides](./dynamic/dynamic.md)
+  - [Reserving space: only and uncover](./dynamic/reserve.md)
+  - [General syntax](./dynamic/syntax.md)
+  - [Complex rules](./dynamic/complex.md)
+  - [Helper functions](./dynamic/helper.md)
+    - [one-by-one and line-by-line](./dynamic/obo-lbl.md)
+    - [pause](./dynamic/pause.md)
+    - [alternatives](./dynamic/alternatives.md)
+  - [Cover mode](./dynamic/cover.md)
+  - [Handout mode](./dynamic/handout.md)
+  - [Internals](./dynamic/internals.md)
+- [Themes](./themes/themes.md)
+  - [Gallery](./themes/gallery/index.md)
+    - [Simple](./themes/gallery/simple.md)
+    - [Clean](./themes/gallery/clean.md)
+    - [Metropolis](./themes/gallery/metropolis.md)
+    - [University](./themes/gallery/university.md)
+    - [Bipartite](./themes/gallery/bipartite.md)
+  - [Build your own](./themes/your-own.md)
+  - [Helpers for theme authors](./themes/helpers.md)