Skip to content

Latest commit

 

History

34 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Minimal Writings

Quick and simple general-purpose notes with extended syntax

Typst Universe version GitHub development branch version

Get Manual Example PDF Example source code Changelog file Contribute with development

General tests badge Build test badge Spellcheck test badge

Quick Start

#import "@preview/min-writing:0.1.0": writing

#set document(
  title: "Title",
  author: "Author",
  description: "Description",
)

#show: writing

// Write typst with expanded syntax (see manual)

Description

Create quick notes intuitively and rapidly, using syntactic sugar that extends the markup supported by Typst. By default, new documents are created in quick-note mode—which ignores page breaks and optimizes the layout for screens—though you can also select the classic paged mode.

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.

Feature List

  • 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 texts
    • Mermaid diagrams
    • Figures (with source)
  • Catppuccin colors
  • Embedded help page

Default Fonts

Text: TeX Gyre Heros or Arial

Headings: TeX Gyre Adventor or Century Gothic

Mono: Fira Mono or Inconsolata

About

Quick and simple general-purpose notes with extended syntax

Topics

Resources

Contributing

Stars

1 star

Watchers

1 watching

Forks

Releases

Contributors

Languages