Skip to main content
Version: 0.1.22

markdown

Load saved themes from markdown files with embedded wallpapers.

Description​

The markdown plugin loads themes previously saved with the markdown output plugin. These files contain:

  • Full colour palette
  • Embedded wallpaper (base64)
  • Theme metadata

Use it to restore themes across systems or sessions.

Usage​

tinct generate -i markdown --markdown.path <file> [flags]

Flags​

FlagDefaultDescription
--markdown.pathPath to theme markdown file (required)

Examples​

Restore a saved theme​

tinct generate -i markdown \
  --markdown.path ~/.config/tinct/themes/mountain-sunset.md \
  -o all

Restore to specific plugins​

tinct generate -i markdown \
  --markdown.path ~/themes/my-theme.md \
  -o hyprland,kitty,waybar

Workflow​

Save a theme​

First, save with the markdown output plugin:

tinct generate -i image -p ~/wallpaper.jpg \
  -o markdown \
  --markdown.name "Mountain Sunset" \
  --markdown.include-thumbnail

Creates: ~/.config/tinct/themes/mountain-sunset.md

Restore later​

tinct generate -i markdown \
  --markdown.path ~/.config/tinct/themes/mountain-sunset.md \
  -o all

Share themes​

The markdown file is portable:

# Copy to another machine
scp ~/.config/tinct/themes/my-theme.md user@other:~/themes/

# On other machine
tinct generate -i markdown \
  --markdown.path ~/themes/my-theme.md \
  -o all

File format​

Saved themes look like:

# Mountain Sunset

Theme generated by tinct.

## Palette

| Role | Hex |
|------|-----|
| background | #1e1e2e |
| foreground | #cdd6f4 |
| accent1 | #89b4fa |
...

## Wallpaper

![Wallpaper](data:image/jpeg;base64,/9j/4AAQSkZJRg...)

## Metadata

- Theme type: dark
- Generated: 2024-01-15T14:30:22Z

Wallpaper handling​

When loading a theme with an embedded wallpaper:

  1. Wallpaper is extracted to temporary file
  2. Path provided to output plugins
  3. Plugins like hyprpaper apply it automatically

Thumbnail​

If --markdown.include-thumbnail was used when saving, the file includes a small preview image for quick identification.

Use cases​

Backup and restore​

# Before reinstall, save current themes
tinct generate -i image -p ~/wallpaper.jpg \
  -o markdown \
  --markdown.name "My Setup"

# After reinstall
tinct generate -i markdown \
  --markdown.path ~/.config/tinct/themes/my-setup.md \
  -o all

Theme collection​

Maintain a collection of themes:

~/.config/tinct/themes/
├── catppuccin-mocha.md
├── nord-aurora.md
├── gruvbox-material.md
└── tokyo-night.md

Quick switch:

tinct generate -i markdown \
  --markdown.path ~/.config/tinct/themes/tokyo-night.md \
  -o all

Version control​

# Add themes to git
cd ~/.config/tinct/themes
git init
git add *.md
git commit -m "Add my themes"

See also​