Skip to content

Latest commit

 

History

1 Commit

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

noteframe

Convert Markdown notes into Instagram-ready images.

CI Crates.io

Write a short .md file, run noteframe post, get a PNG.

Install

From crates.io:

cargo install noteframe

Or build from source:

git clone https://github.com/nobeh/noteframe.git
cd noteframe
just build       # cargo build --release
just install     # puts noteframe in ~/.cargo/bin

Workflow

  1. Write a short .md note with YAML frontmatter
  2. Run noteframe post notes/my-note.md
  3. Get a PNG alongside your note, ready to post

Note format

---
title: "Your insight here"
layout: post        # post (single image) | carousel (one image per ## section)
bg: "#FAFAF8"       # background color
text: "#1A1A1A"     # text color
accent: "#AAAAAA"   # accent / hashtag color
hashtags:
  - mindset
  - design
---

Your post body goes here. Supports **bold**, *italic*, and ***bold italic***.

Frontmatter fields

Field Default Description
title Heading rendered at the top of the image
layout post post (single image) or carousel (one image per ## section)
bg #FFFFFF Background hex color
text #1A1A1A Body text hex color
accent #888888 Accent line and hashtag color
hashtags [] List of tags rendered at the bottom (without #)

Commands

noteframe post notes/my-note.md     # generate PNG(s) from a note
noteframe new "My Post Title"       # scaffold a new note
noteframe new "Title" --layout carousel  # new carousel note

Or via just:

just post notes/my-note.md
just new "My Post Title"
just build
just install

Layouts

  • post — single 1080×1080 PNG; title + body vertically centered
  • carousel — one PNG per ## heading; output named stem-01.png, stem-02.png, …

Fonts & language

Script is auto-detected from content — no configuration needed:

  • Latin / English → Merriweather (regular/italic) + New York Large (bold)
  • Persian / Arabic → Noto Sans Arabic UI; text is right-aligned

Font size auto-scales based on word count — shorter text renders larger.

Output

Generated images are saved alongside the source .md file:

  • notes/my-note.mdnotes/my-note.png
  • notes/my-carousel.mdnotes/my-carousel-01.png, notes/my-carousel-02.png, …

License

MIT

About

Convert Markdown notes into Instagram-ready images.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages