Skip to content

itemplate:0.1.0 - #5729

Open
hexiongwu1995 wants to merge 4 commits into
typst:mainfrom
hexiongwu1995:main
Open

itemplate:0.1.0#5729
hexiongwu1995 wants to merge 4 commits into
typst:mainfrom
hexiongwu1995:main

Conversation

@hexiongwu1995

@hexiongwu1995 hexiongwu1995 commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

I am submitting

  • a new package
  • an update for a package

This package restructures the default exported HTML file to provide a more complex structure for subsequent CSS styling and JS manipulation. CSS and JS resources are provided default from an npm package "@hexiongwu1995/itemplate" but can also be downloaded form this package's sub directory to ensure reliability and stability.

Unfortunatly, the iconfont files can only be accessed from the npm package mentioned above because typst does not support uploading to their repository.

I have read and followed the submission guidelines and, in particular, I

  • selected itemplate that isn't the most obvious or canonical name for what the package does
    • Explanation: the name contains the word "template" which explains itself as a html template. The prefix "i" makes the name very short, easy to remember and sounds unique.

  • 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 itemplate: 0.1.0 itemplate:0.1.0 Aug 31, 2026
@typst-package-check typst-package-check Bot added the new A new package submission. label Aug 31, 2026
@hexiongwu1995

Copy link
Copy Markdown
Contributor Author

I delibrately put all source files associated with this project, except for the iconfont files, in the assets directory to ensure this package always maintains a consistent appearance and functionality. And I think they are necessary and not redundant.

@elegaanz elegaanz self-assigned this Sep 1, 2026

@elegaanz elegaanz 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.

Thank you for this template :)


```typst
// document.typ
#import "@preview/itemplate: 0.1.0": *

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.

There is an extra space before the version number here.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The extra space has been deleted.

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.

Can you remove that file please? It is a compilation artifact and is not referenced anywhere.

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 file too doesn't really belong here, it is more useful for you or other maintainers, so it should only live in your own repository. Can you remove it too, please?

Comment on lines +45 to +46
html.link(rel: "stylesheet", href: "https://unpkg.com/@hexiongwu1995/itemplate/styles/style.css")
// html.link(rel: "stylesheet", href: "./assets/styles/style.css")

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.

Regarding assets management, you should either:

  • Use unpkg all the time and remove the local copies of the files
  • Use bundle export to re-export them along the HTML document, and stop relying on unpkg. You can keep using for font files, load them from another third-party, or add a parameter that lets users provide the font files themselves.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I choose to use the unpkg method. All css and js files has been removed.

@elegaanz elegaanz added the waiting-on-author Pull request waits on author label Sep 3, 2026
…epository are removed. The import error from README.md has been corrected.
@typst-package-check typst-package-check Bot removed the waiting-on-author Pull request waits on author label Sep 3, 2026
@hexiongwu1995

Copy link
Copy Markdown
Contributor Author

@elegaanz I have made some changes, please check this package again.

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