andreasKroepelin / polylux

A package for creating slides in Typst
https://polylux.dev/book
MIT License
1.1k stars 50 forks source link

Examples should use [] instead of "" for title etc. #37

Open Enivex opened 1 year ago

Enivex commented 1 year ago

If you wish to use markup in a title, say an en-dash between names, or italic, you need to swap "" for []. Someone new to typst might not know this, so I think it would be good idea to use this in the documentation. That is, for instance

#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],
)

(I ran into this while making a presentation today.)

MarkBlyth commented 1 year ago

I've also ran into this, and took me a while to figure out it needs content blocks instead of strings. I'd be happy to change the examples @andreasKroepelin ?

drupol commented 1 year ago

I also support this change.

andreasKroepelin commented 1 year ago

I've also ran into this, and took me a while to figure out it needs content blocks instead of strings. I'd be happy to change the examples @andreasKroepelin ?

That would be great, thanks!