Conversation
| } | ||
|
|
||
|
|
||
| #let demo_doc = [ |
There was a problem hiding this comment.
People don't generally read the source code of a package, and it's not that straight forward to access. It would make sense to include the content of demo_doc as an example file that you link in the readme.
There was a problem hiding this comment.
Added a dedicated demo.pdf in git-tracked directory and the GitHub file URL in README. Is this the best practice?
There was a problem hiding this comment.
I wouldn't include PDF examples, since they can't be viewed directly without downloading them. I was thinking more of a demo.typ file that you link in the readme, and maybe some images so people can directly see what this package does in the readme.
There are two options:
- You include the documentation files in this PR, link to them locally, e.g.
[demo.typ](docs/demo.typ), and add them to theexcludelist in thetypst.tomlmanifest. See: https://github.com/typst/packages/blob/main/docs/tips.md#what-to-commit-what-to-exclude - You add a link to a file in your own repository. Make sure to either create a perma-link or link to a specific tag/branch, to ensure the linked files always match the correct package version.
There was a problem hiding this comment.
I added PDF in my repo with a permalink and removed it from the PR. Is that good?
I am submitting
Description: Unshrink full-width punctuation marks. A workaround for typst#7643.
I have read and followed the submission guidelines and, in particular, I
typst.tomlfile with all required keysREADME.mdwith documentation for my packageLICENSEfile or linked one in myREADME.mdexcluded PDFs or README images, if any, but not the LICENSE