Skip to content

Conversation

angelonazzaro
Copy link

@angelonazzaro angelonazzaro commented Sep 11, 2025

I am submitting

  • a new package
  • an update for a package

Description: TypXidian is a template for academic documents (reports, thesis, note taking) enriched with callout boxes inspired by Obsidian, custom definitions and theorems environments and more.

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 Sep 11, 2025
repository = "https://github.com/angelonazzaro/typxidian"

[template]
path = "./"
Copy link
Member

Choose a reason for hiding this comment

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

Templates should be in a subdirectory of your package. Only that subdirectory (and all of it) will be copied when initializing a project from your template, so it should contain your template's main file and any assets it depends on.

To use this package just add the following code to your [Typst](https://github.com/typst/typst) document:

```typst
#import "@preview/typxidian:0.0.1": template
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
#import "@preview/typxidian:0.0.1": template
#import "@preview/typxidian:0.1.0": template

Copy link
Member

Choose a reason for hiding this comment

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

Can you please specify the license of the images you are shipping with the package, if they were shot by someone else and/or are not under the MIT license as the rest of the code. It can just be a short line in your README.

@elegaanz elegaanz self-assigned this Sep 15, 2025
@angelonazzaro
Copy link
Author

Hello, I will close this pull request and open a new one with the update changes as I am having problems with sparse-checkout.

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