Skip to content

Conversation

@edgaremy
Copy link
Contributor

I am submitting

  • a new package
  • an update for a package

Description: Explain what the package does and why it's useful.

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 added the new A new package submission. label Nov 26, 2025
@edgaremy
Copy link
Contributor Author

Hello :)
I created a package for visualizing Neural Network Architectures, let me know if there are changes that need to be made to this PR !

@elegaanz
Copy link
Member

Nice package, thank you for building it. My only remark before we can publish it is about images and links in your README. You should either:

  • link to your own GitHub repository (as you are currently doing) but with a "pinned" URL, by replacing main in the URL by some Git tag or commit hash. This way, even if you update your repository in the future (while developing the next version of the package), the documentation for the published version will be kept in sync. In this case, the examples and gallery directories in this repository are redundant and should be deleted.
  • use the images and example files you copied in this repository directly, with a relative link.

@elegaanz elegaanz self-assigned this Nov 28, 2025
@edgaremy
Copy link
Contributor Author

Nice package, thank you for building it. My only remark before we can publish it is about images and links in your README. You should either:

* link to your own GitHub repository (as you are currently doing) but with a "pinned" URL, by replacing `main` in the URL by some Git tag or commit hash. This way, even if you update your repository in the future (while developing the next version of the package), the documentation for the published version will be kept in sync. In this case, the examples and gallery directories in this repository are redundant and should be deleted.

* use the images and example files you copied in this repository directly, with a relative link.

Okay thanks for the feedback, I'll change the README with relative links.
Will Relative links to code files or folder also work on Typst Universe ?

@elegaanz
Copy link
Member

I don't think folders will work. What we do is that we redirect these relative links to the raw file on this GitHub repository, so folders will just return a 404 error.

@edgaremy
Copy link
Contributor Author

Ok all should be good now, using relative links for images and permalinks for repo file and folder linking

@edgaremy
Copy link
Contributor Author

@elegaanz ok should be good for merging now :)

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