Skip to main content
Version: main

markdown

Export themes to portable markdown format.

Description​

The markdown plugin exports your colour palette to a markdown file with embedded colours and optional wallpaper. This format allows you to save, share, and reload themes later using the markdown input plugin.

Output path​

~/.config/tinct/themes/<name>.md

Usage​

tinct generate -i image -p ~/wallpaper.jpg -o markdown --markdown.name="sunset-forest"

Without embedding wallpaper​

tinct generate -i image -p ~/wallpaper.jpg -o markdown \
  --markdown.name="sunset-forest" \
  --markdown.no-embed

With thumbnail preview​

tinct generate -i image -p ~/wallpaper.jpg -o markdown \
  --markdown.name="sunset-forest" \
  --markdown.include-thumbnail

Flags​

FlagDefaultDescription
--markdown.name(required)Theme name for filename and metadata
--markdown.dir~/.config/tinct/themesOutput directory
--markdown.no-embedfalseReference wallpaper externally instead of embedding
--markdown.include-thumbnailfalseInclude thumbnail preview in the file

Generated format​

The markdown file contains structured metadata that can be parsed by tinct:

# sunset-forest

A theme generated by tinct.

## Metadata

- **Version:** 1.0
- **Generator:** tinct v0.1.0
- **Generated:** 2024-01-15T10:30:00Z

## Colors

| Role | Hex | Weight |
|------|-----|--------|
| background | #1e1e2e | 0.15 |
| foreground | #cdd6f4 | 0.10 |
| accent1 | #89b4fa | 0.08 |
| accent2 | #f5c2e7 | 0.07 |
| danger | #f38ba8 | 0.05 |
| success | #a6e3a1 | 0.05 |
| warning | #f9e2af | 0.05 |
| info | #94e2d5 | 0.05 |
...

## Ambience

| Region | Hex | Weight |
|--------|-----|--------|
| top_left | #2d1f3d | 0.12 |
| top_right | #1f2d3d | 0.10 |
...

## Wallpaper

[EMBEDDED:image/jpeg]
/9j/4AAQSkZJRgABAQAAAQABAAD...

Reloading saved themes​

Use the markdown input plugin to reload a saved theme:

tinct generate -i markdown -p ~/.config/tinct/themes/sunset-forest.md \
  -o kitty -o alacritty -o hyprland

Theme portability​

The markdown format enables:

  • Backup: Save your favourite themes for later
  • Sharing: Share themes with others (with or without wallpaper)
  • Cross-machine sync: Keep themes in sync across systems
  • Version control: Track theme changes in git

Embedding vs external reference​

Embedded wallpaper (default)​

  • Wallpaper is base64-encoded in the file
  • Fully self-contained and portable
  • Larger file size

External reference (--markdown.no-embed)​

  • File contains path to original wallpaper
  • Smaller file size
  • Wallpaper must exist at the referenced path

See also​