https://github.com/otto-aa/dashy-todo

https://github.com/otto-aa/dashy-todo

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/otto-aa/dashy-todo
• Owner: Otto-AA
• License: mit-0
• Created: 2024-07-22T14:32:31.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-07-24T16:01:28.000Z (4 months ago)
• Last Synced: 2024-07-24T18:33:14.626Z (4 months ago)
• Language: Typst
• Size: 43.9 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Dashy TODO

Create TODO comments, which are displayed at the sides of the page.

![Screenshot](example.svg)

## Limitations

Currently, there is no prevention of TODOs being rendered on top of each other. See [here](https://github.com/Otto-AA/dashy-todo/issues/1) for more information.

## Usage

The package provides a `todo(message, position: auto | left | right)` method. Call it anywhere you need a todo message.

```typst

#import "@preview/dashy-todo:0.0.1": todo

// It automatically goes to the closer side (left or right)

A todo on the left #todo[On the left].

// You can specify a side if you want to

#todo(position: right)[Also right]

// You can add arbitrary content

#todo[We need to fix the $lim_(x -> oo)$ equation. See #link("https://example.com")[example.com]]

// And you can create an outline for the TODOs

#outline(title: "TODOs", target: figure.where(kind: "todo"))

```

## Styling

You can modify the text by wrapping it, e.g.:

```

#let small-todo = (..args) => text(size: 0.6em)[#todo(..args)]

#small-todo[This will be in fine print]

```