Skip to content

carterworks/yazzy

Repository files navigation

yazzy

Article → Markdown/plain text, for easy-reading archival purposes.

Named after Jasnah Kholin, famous historian/archivist in Brandon Sanderson's The Stormlight Archive.

Features

  • Extracts the main content from any web article using Mozilla's Readability
  • Converts web content to clean Markdown, HTML, or plain text format.
  • Simple URL pattern - just prepend the yazzy URL: "yazzy.fly.dev/https://example.com".
  • Download articles as Markdown, plain text, or copy to clipboard.
  • Export in Obsidian-compatible format with frontmatter metadata.
  • Dark mode support for comfortable reading.
  • AI-powered article summarization.
  • Easily self-hostable.
  • Database dumps for backing up your article collection.
  • Minimalist, distraction-free reading experience.

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command Action
bun install Installs dependencies
bun run dev Builds the css and starts a reloading dev server
bun run css Builds just the css
bun run build Builds a production-ready archive into ./dist
bun run check Format and lint the project

TODO

  • Local history
  • Update to the new Obsidian URI format (content in clipboard)
  • A service worker for speed and offline work.
  • Reader mode preferences (font size, line spacing, font family)
  • Custom CSS themes support for personalized reading experience
  • Reading time estimation for articles
  • Social sharing with preview cards