Skip to content

min-writing:0.1.0 - #5663

Open
mayconfmelo wants to merge 2 commits into
typst:mainfrom
mayconfmelo:min-writing
Open

min-writing:0.1.0#5663
mayconfmelo wants to merge 2 commits into
typst:mainfrom
mayconfmelo:min-writing

Conversation

@mayconfmelo

@mayconfmelo mayconfmelo commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

I am submitting

  • a new package
  • an update for a package

Description: Create quick notes intuitively and rapidly, using syntactic sugar that extends the markup supported by Typst. This package was designed to make creating documents as easy as possible, without requiring extensive initial
configuration—in fact, you simply need to import the package and apply the #show rule to access its
features—yet it still offers various options for fine-tuning.

  • Quick-note mode (no page breaks)
  • Extended syntax sugar
    • Unnumbered headings
    • Highlighted texts
    • Boxed texts
    • Inline quotes
    • Block quotes
    • Tables
    • Paragraph breaks
    • Page breaks
    • Mermaid diagrams
    • Dividers
    • Check lists
  • Additional commands
    • #boxed for boxed texts
    • #mermaid for Mermaid diagrams
    • Custom #figure with support for source
  • Catppuccin colors
  • Embedded help page

PS: The thumbnail differs from the template because, by default, the package creates a single-page document with an automatic height, and the generated template does not match standard paper proportions; consequently, the resulting thumbnail does not fit well within the Typst Universe site's thumbnail display.

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: It is the shorthand for "minimal-writing," part of the "min-" family of templates I developed. The name "minimal" reflects the minimal effort required to configure and use this package.
  • 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 added the new A new package submission. label Aug 24, 2026
@elegaanz elegaanz self-assigned this Aug 24, 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.

Two small things. The second comment in particular needs to be addressed, so that users don't download a package they don't need.

@@ -0,0 +1,72 @@
/// = Additional commands

#let original = (figure: figure, align: align)

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, you can use the std module instead of making aliases manually: std.figure will always refer to the "original" figure function (unless you create a variable called std too, of course). You don't have to change it for your package to be accepted, but I wanted to let you know in case you need it again in the future.

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 completely forgot about std! Thanks for reminding me; it's much easier than manually keeping track of all the shadowed functions.

body /// <- content | string
/// Text to be boxed. |
) = context {
import "@preview/catppuccin:1.1.0": get-flavor

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 seems unused. If that's right, can you remove please?

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've removed it. That import was a leftover from the previous implementation, which was intended to fetch the color theme from within the command. When I changed the approach, I forgot to remove it. Sorry!

@mayconfmelo

Copy link
Copy Markdown
Contributor Author

The issues pointed out were resolved in the last commit 🙂

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