https://github.com/nleanba/typst-marginalia

Marginnotes for typst with smart positioning
https://github.com/nleanba/typst-marginalia

typst typst-package

Last synced: 3 months ago
JSON representation

Marginnotes for typst with smart positioning

• Host: GitHub
• URL: https://github.com/nleanba/typst-marginalia
• Owner: nleanba
• License: unlicense
• Created: 2024-11-17T12:34:28.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-12-04T16:57:08.000Z (6 months ago)
• Last Synced: 2026-01-15T20:29:41.497Z (5 months ago)
• Topics: typst, typst-package
• Language: Typst
• Homepage: https://typst.app/universe/package/marginalia
• Size: 13.6 MB
• Stars: 62
• Watchers: 1
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: .github/README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

          
# Marginalia

_Configurable margin-notes with smart positioning and matching wide blocks for

Typst_

> [!NOTE]

> This is the readme file for the project repository and contains more

> development-oriented info.

>

> [A more friendly readme for the published package can be found on Typst Universe.](https://typst.app/universe/package/marginalia).

## Docs

- [Current Published Version: v0.3.1](https://github.com/nleanba/typst-marginalia/blob/v0.3.1/Marginalia.pdf?raw=true)

- [Working Copy](https://github.com/nleanba/typst-marginalia/blob/main/Marginalia.pdf?raw=true)

  [![first page of the documentation](https://github.com/nleanba/typst-marginalia/raw/refs/heads/main/preview.svg)](https://github.com/nleanba/typst-marginalia/blob/main/Marginalia.pdf)

## Development

- Remember to `typst watch main.typ Marginalia.pdf` and

  `typst watch main.typ preview.svg --pages 1` while development to make these

  stay current.

### Tests

Use `tt run` to check for test regressions.

The tests don’t necessarily represent _ideal_ behavior. If the behavior

improves, they should be updated. Use `tt update ` to update the reference

of a test, and `tt new ` to create a new test.

> [!IMPORTANT]

> Note that the tests need to have a modified `numbering` style as the GitHub CI

> runner does not have Inter.

### New Versions

1. Replace all occurrences of the old version number with the new one, except

   where it refers to specific changes made in that version.

- Also replace placeholder `?.?.?` with the new number.

2. Commit and create a tagged release.

3. “Sync Fork” in https://github.com/nleanba/typst-packages

4. In `nleanba/typst-packages`, Pull and create new branch from main

5. Create folder `packages/preview/marginalia/` and copy `LICENSE`,

   `README.md`, `lib.typ`, and `typst.toml`

6. Commit and create a pull-request to `typst/packages`.

7. `main.typ`: reset `#let VERSION = "?.?.?"`.

### Contributing

This is a personal project of mine. I welcome bug reports and feature requests,

but I don’t consider this a community project and have no real interest in

reviewing pull-requests etc.

## Feedback

Have you encountered a bug?

[Please report it as an issue.](https://github.com/nleanba/typst-marginalia/issues)

Has this package been useful to you?

[I am always happy when someone gives me a ~~sticker~~ star⭐](https://github.com/nleanba/typst-marginalia)