Skip to content

perlit:0.0.1#4470

Merged
saecki merged 6 commits intotypst:mainfrom
lucaengelhard:main
Apr 2, 2026
Merged

perlit:0.0.1#4470
saecki merged 6 commits intotypst:mainfrom
lucaengelhard:main

Conversation

@lucaengelhard
Copy link
Copy Markdown
Contributor

@lucaengelhard lucaengelhard commented Mar 30, 2026

I am submitting

  • a new package
  • an update for a package

Description: Graph creator from Obsidian graphs.

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 Mar 30, 2026
@saecki
Copy link
Copy Markdown
Member

saecki commented Apr 2, 2026

Thanks for this package!

For future releases it might be nice to have a fully working example with a json example file to try out this package.

@saecki saecki merged commit 5621448 into typst:main Apr 2, 2026
3 checks passed
@lucaengelhard
Copy link
Copy Markdown
Contributor Author

Thank you!

For future releases it might be nice to have a fully working example with a json example file to try out this package.

Should that example just be in an example folder or how should that be structured

@saecki
Copy link
Copy Markdown
Member

saecki commented Apr 3, 2026

Should that example just be in an example folder or how should that be structured

If the json isn't too long, you could also include it inline like so:

#json(```json
{ "key": "value" }
```.text)

Otherwise I'd just link an example json file, which can be used to try out the package.
Having the code examples in the readme is fine, but you can also put them in separate files :)

See: https://github.com/typst/packages/blob/main/docs/documentation.md#writing-package-documentation
and https://github.com/typst/packages/blob/main/docs/tips.md#what-to-commit-what-to-exclude

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