typst / typst/packages

Support thumbnails for packages

Open
#1,210 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
1k
Forks
1.3k
Avg merge
2d 22h
Merged PRs (30d)
189

Description

Description

Templates on the Typst Universe have thumbnails, which greatly help with distinguishing between them and getting a notion of what they do and how they look at a glance. I think it would be helpful for packages to have thumbnails too; currently they all have the same crate (<div role="img" class="package-icon"></div>) as their thumbnail.

Ideas for guidelines:

  • Thumbnails should be clear even in small sizes.
  • They should depict a logo or a representative cropped shot that demonstrates concisely what the package does, maximising the relevant information to clutter ratio.
  • Care should be taken not to use shocking colours and patterns: draw attention to your package by providing good functionality and documentation, not by having a flashy thumbnail.

(Issue copied from the Forum)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue provides design guidelines for package thumbnails but names no implementation files, entry points, or tests. Start by locating the current package icon rendering and the existing template thumbnail support; done means packages can provide suitable thumbnails that display correctly at small sizes and are covered by appropriate tests.

Written by the indexing model from the issue text.

Assessment

Domain
design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.