Skip to content

Conversation

@Freezy727
Copy link

I am submitting

  • a new package
  • an update for a package

Description: CV template useful for quickly drafting a CV.

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
  • 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.

@typst-package-check typst-package-check bot added the new A new package submission. label Nov 12, 2025
@Freezy727
Copy link
Author

Hi, how do I correctly specify the exclude key in the toml file to ignore the pdf under the template directory? "template/example.pdf" didn't seem to work. (Also in the section on what to exclude, it says that any file in the template directory is required, so this could maybe be clarified to not always be the case... Unless I missed somewhere that I wasn't supposed to put the pdf under the template directory in the first place 😅)

Also not sure why I'm failing the test on the readme being valid UTF-8 so if someone could explain the issue I'll try to fix it!

@elegaanz elegaanz self-assigned this Nov 13, 2025
@elegaanz
Copy link
Member

Thank you for building this template. Can you please fix the CI errors?

@Freezy727
Copy link
Author

Freezy727 commented Nov 13, 2025

@elegaanz Fixed the readme encoding issue, but can't find how to exclude the pdf from being included in the package ("template/example.pdf" did not work as an exclude key in the toml). Can you point me to how to fix this, or is it necessary to outright delete the file from the repository?

@elegaanz
Copy link
Member

Yes, in this case you should just delete the file, otherwise it would get copied to user projects when using your template, which is not desirable, especially in the web app where no PDF is produced unless asked.

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