Skip to content

justwhitee-notes:0.1.0#4196

Merged
elegaanz merged 37 commits intotypst:mainfrom
itsjustwhitee:justwhitee-notes-template
Mar 4, 2026
Merged

justwhitee-notes:0.1.0#4196
elegaanz merged 37 commits intotypst:mainfrom
itsjustwhitee:justwhitee-notes-template

Conversation

@itsjustwhitee
Copy link
Copy Markdown
Contributor

@itsjustwhitee itsjustwhitee commented Feb 25, 2026

I am submitting

  • a new package
  • an update for a package

Description: Explain what the package does and why it's useful.

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 changed the title Add justwhitee-notes template (version 0.1.0) justwhitee-notes:0.1.0 Feb 25, 2026
@typst-package-check typst-package-check Bot added the new A new package submission. label Feb 25, 2026
Corrected spelling errors in README.md regarding image cropping and font stacks.
…pg to packages/preview/justwhitee-notes/0.1.0/assets/icon.jpg
…svg to packages/preview/justwhitee-notes/0.1.0/default/logo.svg
@saecki saecki self-assigned this Mar 3, 2026
@elegaanz elegaanz assigned elegaanz and unassigned saecki Mar 3, 2026
Copy link
Copy Markdown
Member

@elegaanz elegaanz left a comment

Choose a reason for hiding this comment

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

Thank you, I have left some remarks about the package structure and its documentation.

Comment on lines +9 to +10
logo-personal: "default/logo.svg",
logo-subject: "assets/icon.jpg",
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 won't work as expected, as explained here.


### 1. Import the template

Place `lib.typ` in your project directory and import it at the top of your main file:
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.

No need to copy lib.typ, the compiler will be able to download the package automatically once this PR is merged.


## 📁 Recommended Project Structure

It is recommended to insert assets in `assets/` folder and your logo and eventually the course/subject logo on `default/`.
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.

For info these folders will not be visible to people using your template, they are only part of the package.

…kages/preview/justwhitee-notes/0.1.0/template/assets/icon.jpg
Added instructions for initializing a new project with Typst CLI.
Removed recommended project structure section from README.
Updated logo references to use the image() function for better compatibility.
@itsjustwhitee
Copy link
Copy Markdown
Contributor Author

Hi @elegaanz, thank you for the feedback! I have pushed the fixes: I moved the assets and default folders inside the template directory so they will be correctly downloaded by typst init, and I also fixed the template to work with this modification. Additionally, I updated the README with the official import instructions.
Let me know if everything looks good now!

@elegaanz
Copy link
Copy Markdown
Member

elegaanz commented Mar 4, 2026

Looks good, thank you!

@elegaanz elegaanz merged commit e218b46 into typst:main Mar 4, 2026
3 checks passed
leostudiooo pushed a commit to leostudiooo/packages that referenced this pull request Mar 19, 2026
retroflexivity pushed a commit to retroflexivity/typst-packages that referenced this pull request Mar 19, 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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants