Skip to content

strict-modern-uestc-thesis:2.0.0#5157

Open
kong13661 wants to merge 1 commit into
typst:mainfrom
kong13661:main
Open

strict-modern-uestc-thesis:2.0.0#5157
kong13661 wants to merge 1 commit into
typst:mainfrom
kong13661:main

Conversation

@kong13661

Copy link
Copy Markdown

I am submitting

  • a new package
  • an update for a package

Description: This is the uestc thesis. Compared to the modern-uestc-thesis, this template implement the whole format in the the university word template.

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
    • Explanation:
  • 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 changed the title uestc-thesis uestc-thesis:2.0.0 Jun 24, 2026
@typst-package-check typst-package-check Bot added the new A new package submission. label Jun 24, 2026
@SchrodingerBlume

Copy link
Copy Markdown
Contributor

Hi, spotted this while checking on my own PR, wanted to share a couple of things!

uestc-thesis might not pass review. Bare org abbreviations like uestc are reserved for official templates per the naming rules (https://github.com/typst/packages/blob/main/docs/manifest.md#naming-rules). A prefix should do the trick, or email hello@typst.app if it's official.

Also, just a thought, the comparison with other templates in the description might not be necessary? Your template stands on its own either way! 😊

Good luck with the submission!

@typst-package-check typst-package-check Bot changed the title uestc-thesis:2.0.0 strict-modern-uestc-thesis:2.0.0 Jun 25, 2026
@kong13661

Copy link
Copy Markdown
Author

Hi, spotted this while checking on my own PR, wanted to share a couple of things!

uestc-thesis might not pass review. Bare org abbreviations like uestc are reserved for official templates per the naming rules (https://github.com/typst/packages/blob/main/docs/manifest.md#naming-rules). A prefix should do the trick, or email hello@typst.app if it's official.

Also, just a thought, the comparison with other templates in the description might not be necessary? Your template stands on its own either way! 😊

Good luck with the submission!

Thanks for your review. I have rename the template name to strict-modern-uestc-thesis. Besides, there is no comparison content in this template, such as typst.toml and README file. The purpose for the comparision is for review.

@saecki saecki self-assigned this Jun 25, 2026

@saecki saecki left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for this package!

@@ -0,0 +1 @@
#import "../uestc-thesis-template/lib.typ": *

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This import should use a package specification (@preview/...)

<img alt="Apache-2 License" src="https://img.shields.io/badge/license-Apache%202-brightgreen"
></a>

<a href="https://github.com/kong13661/thesis-example/blob/output/%E5%AD%A6%E4%BD%8D%E8%AE%BA%E6%96%87%E5%86%99%E4%BD%9C%E6%8C%87%E5%8D%97%E5%8F%8A%E4%BE%8B%E5%AD%90.pdf">

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could you either use a perma-link or a link to a specific branch/tag of a version? That way the linked resources will always match the published version of the package.

无须给本仓库Star, 建议给[模板](https://github.com/uestc-typst/thesis-template)仓库点Star!有问题也需要在[模板](https://github.com/uestc-typst/thesis-template)仓库提issues. 本[仓库地址](https://github.com/uestc-typst/thesis-example).

<h1 align="center">
<img alt="Typst" src="https://github.com/uestc-typst/thesis-template/blob/main/pics/uestc-love-typst.png">

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Same here, could you please either use a perma-link or a link to a specific branch/tag?

[package]
name = "strict-modern-uestc-thesis"
version = "2.0.0"
entrypoint = "example/uestc-thesis-template/lib.typ"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This isn't quite the way template packages are supposed to be structured.
The package entrypoint should be outside of the template directory and the template/example should use the package using an @preview import. This ensures the user can upgrade by changing the version on the import of the package. when a newer version is released. See: https://github.com/typst/packages/blob/main/docs/manifest.md#templates

We currently don't accept packages that only provide template/example code without a reusable core.

If I understand correctly though. I think you just need to move the src directory out of the example directory and update the imports :)

entrypoint = "example/uestc-thesis-template/lib.typ"
authors = ["UESTC Typst Community"]
license = "Apache-2.0"
description = "电子科技大学本科/硕士/博士学位论文模板,博士模板已经过学校验证,支持常用的表格,图像修订模式等。"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could you either also add an english description, or replace the description with an english one?

<h1 align="center">
<img alt="Typst" src="https://github.com/uestc-typst/thesis-template/blob/main/pics/uestc-love-typst.png">
</h1>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It is generally appreciated to have at least an introduction sentence in English, even if the target audience for the template is not native English speakers. This allows the broader Typst community to get an idea of what the package is about and make sure that it isn't of interest to them.


无须给本仓库Star, 建议给[模板](https://github.com/uestc-typst/thesis-template)仓库点Star!有问题也需要在[模板](https://github.com/uestc-typst/thesis-template)仓库提issues. 本[仓库地址](https://github.com/uestc-typst/thesis-example).

<h1 align="center">

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'm not sure how well this will work on Typst Universe because there all h1 headings are removed and the package name is added as the h1 heading of the page. I don't know how to test this, so we can just give it a try and publish a new version if this fails somehow.
Just wanted to give you a heads up :)

@saecki saecki added the waiting-on-author Pull request waits on author label Jun 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new A new package submission. waiting-on-author Pull request waits on author

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants