Skip to content

cjk-unshrink:0.1.0#4406

Open
neruthes wants to merge 6 commits intotypst:mainfrom
neruthes:cjk-unshrink
Open

cjk-unshrink:0.1.0#4406
neruthes wants to merge 6 commits intotypst:mainfrom
neruthes:cjk-unshrink

Conversation

@neruthes
Copy link
Contributor

I am submitting

  • a new package
  • an update for a package

Description: Unshrink full-width punctuation marks. A workaround for typst#7643.

I have read and followed the submission guidelines and, in particular, I

  • selected a name that isn't the most obvious or canonical name for what the package does
  • added a typst.toml file with all required keys
  • added a README.md with documentation for my package
  • have chosen a license and added a LICENSE file or linked one in my README.md
  • tested my package locally on my system and it worked
  • excluded PDFs or README images, if any, but not the LICENSE

@typst-package-check typst-package-check bot changed the title Cjk unshrink cjk-unshrink:0.1.0 Mar 20, 2026
@typst-package-check typst-package-check bot added the new A new package submission. label Mar 20, 2026
Copy link
Member

@saecki saecki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this package!

}


#let demo_doc = [
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a dedicated demo.pdf in git-tracked directory and the GitHub file URL in README. Is this the best practice?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

  1. You include the documentation files in this PR, link to them locally, e.g. [demo.typ](docs/demo.typ), and add them to the exclude list in the typst.toml manifest. See: https://github.com/typst/packages/blob/main/docs/tips.md#what-to-commit-what-to-exclude
  2. 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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added PDF in my repo with a permalink and removed it from the PR. Is that good?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new A new package submission.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants