Skip to content

Conversation

hugoledoux
Copy link

@hugoledoux hugoledoux commented Sep 16, 2025

I am submitting

  • a new package
  • an update for a package

A Typst template that (more or less) replicates the TUDelft letter, which is only available in Word...

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

  • [X ] 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 changed the title Add files v0.1.0 of tud-letter tud-letter:0.1.0 Sep 16, 2025
@typst-package-check typst-package-check bot added the new A new package submission. label Sep 16, 2025
@saecki saecki self-assigned this Sep 18, 2025
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! I've left a few comments regarding the name, description, and the readme example.

@@ -0,0 +1,16 @@
[package]
entrypoint = "src/lib.typ"
name = "tud-letter"
Copy link
Member

Choose a reason for hiding this comment

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

If you want this to be an official package, a faculty member needs to send an email to hello@typst.app endorsing this package. Otherwise the name needs to be prefixed by some non-descriptive part, so that multiple packages can co-exist. See our naming rules.

Copy link
Author

Choose a reason for hiding this comment

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

I am actually a faculty member: https://www.tudelft.nl/staff/h.ledoux/ + https://3d.bk.tudelft.nl/hledoux but I don't think I have personally the authority to create an official template for my university... But then I don't think anyone at the central admin will do it either.

prefixing is surely simpler. Would "almost-tud-letter" be okay?

Copy link
Member

Choose a reason for hiding this comment

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

almost-tud-letter would work. I'm also not quite sure who has the authority to create official templates, if you figure that out we can always publish a new version of this package under the official name :)

compiler = "0.13.0"
authors = ["Hugo Ledoux <@hugoledoux>"]
repository = "https://github.com/hugoledoux/tudletter"
description = "A Typst template that (almost?) replicates the TUDelft letter"
Copy link
Member

Choose a reason for hiding this comment

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

The word typst is somewhat redundant here and should be omitted. See: https://github.com/typst/packages/blob/main/docs/manifest.md#writing-a-good-description

## Example

```typst
#import "../src/lib.typ": *
Copy link
Member

Choose a reason for hiding this comment

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

The example should use a package specification

Suggested change
#import "../src/lib.typ": *
#import "@preview/tud-letter:0.1.0": *

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