Skip to content

carterworks/yazzy

Repository files navigation

Astro Starter Kit: Minimal

npm create astro@latest -- --template minimal

Open in StackBlitz Open with CodeSandbox Open in GitHub Codespaces

🧑‍🚀 Seasoned astronaut? Delete this file. Have fun!

🚀 Project Structure

Inside of your Astro project, you'll see the following folders and files:

/
├── public/
├── src/
│   └── pages/
│       └── index.astro
└── package.json

Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.

There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

Any static assets, like images, can be placed in the public/ directory.

🧞 Commands

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

Command Action
npm install Installs dependencies
npm run dev Starts local dev server at localhost:4321
npm run build Build your production site to ./dist/
npm run preview Preview your build locally, before deploying
npm run astro ... Run CLI commands like astro add, astro check
npm run astro -- --help Get help using the Astro CLI

👀 Want to learn more?

Feel free to check our documentation or jump into our Discord server.

yazzy

Website → Markdown/plain text, for archival purposes.

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

Ideas/plan

  • Similar to txtify.it or Steph Ango's Obsidian Web Clipper, but server-side.
  • A mobile share target via PWA share_target.
  • Do the "prepend the yazzy url" thing, like "yazzy.fly.dev/https://example.com".
  • Can download the markdown file or copy the text to clipboard.
  • Only hotlinks the images (for now?)
  • (Partially working) Caches text to an sqlite db
    • inserting into the cache is broken, but only in docker containers
  • Uses Mozilla's Readability.
  • Runs on Bun.
  • Has a job queue for processing?
  • Caching headers to static resources
  • Bring-your-own OpenAI key for summaries
  • Deployed on Fly.io.
  • Dark mode
  • Remember which mode (html/markdown/text) was used
  • recognize the language from codeblocks

Setup

To install dependencies:

bun install

To run:

bun dev # or bun dev for file watching

To format/lint:

bun check

To build for production

bun build