progressive-layout:1.0.0 #3361
Open
progressive-layout:1.0.0 #3361
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… package submission
elegaanz
reviewed
Nov 3, 2025
Member
elegaanz
left a comment
elegaanz
left a comment
There was a problem hiding this comment.
Two small suggestions to improve your README.
| #import "@preview/progressive-layout:1.0.0": progressive-layout, progressive-outline | ||
|
|
||
| // Apply the template to your document | ||
| #show: doc => progressive-layout(doc) |
Member
There was a problem hiding this comment.
It is more idiomatic to write #show doc: progressive-layout, can you please update the example here (and other example files, using .with(...) in case you need to supply other arguments)?
| This package includes two files to demonstrate its usage: | ||
|
|
||
| - [`example.typ`](https://github.com/eusebe/progressive-layout/blob/main/example.typ): This file shows how the `progressive-outline` function works with different options. | ||
| - [`demo.typ`](https://github.com/eusebe/progressive-layout/blob/main/demo.typ): This file provides an example of how to use the `progressive-layout` template. |
Member
There was a problem hiding this comment.
I would either:
- link to the files in this repository (i.e.
[\example.typ`](example.typ)`) - delete the copy of the files in this repository, and link to a pinned commit or tag in your own repository (by replacing
mainin the URL with the commit hash or tag name)
This was, you can be sure that the example files will always be in sync with the version of the package the user is reading the README for. Currently, if you push a breaking API change, the examples won't work anymore for people still reading the old README.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I am submitting
Description: This package provides a Typst function,
progressive-outline, and a tempate,progressive-layout, to generate a dynamic table of contents, similar to what is found in some LaTeX's Beamer presentations.I have read and followed the submission guidelines and, in particular, I
[X ] selected a name that isn't the most obvious or canonical name for what the package does
[ X] added a
typst.tomlfile with all required keys[ X] added a
README.mdwith documentation for my package[ X] have chosen a license and added a
LICENSEfile or linked one in myREADME.md[ X] tested my package locally on my system and it worked
[ X]
excluded PDFs or README images, if any, but not the LICENSE[ X] ensured that my package is licensed such that users can use and distribute the contents of its template directory without restriction, after modifying them through normal use.