progressive-layout:1.0.0 #3361
progressive-layout:1.0.0 #3361
Conversation
… package submission
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) |
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. |
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.
|
Hey, just a reminder that there some small details to be fixed before we can merge this PR. Do you think you will have time to do so in the coming days? No worries if not, but in that case I will close this PR to keep our review backlog clear. |
|
The Just hoping the remaining feedback is incorporated into the PR so it can be merged for Typst Universe. Wish you both a great start of the new year! /robin Edit: A PR has been submitted to the upstream repo (eusebe/progressive-layout#1) which includes fixes for the review comments that Ana gave. |
|
I'll close for now, feel free to open a new PR once the review comments have been addressed. :) |
|
Hi everyone, Sorry for my long silence, I should have replied earlier. In the meantime, I ended up completely rewriting the functionality and integrating it into a new package called navigator, which I’m about to submit to Typst Universe. Given how much the design changed, it made more sense to start fresh rather than updating this PR. Thanks a lot for the review, suggestions, and patience, they were genuinely helpful. And apologies again for the delay on my side. Best, |
|
No worries, glad to hear you are working on a new package :) |
3 participants
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.