openflarestack Star this repo
  1. Catalog
  2. Notes
  3. mdread
Ranked 134 of 234

mdread

techjewel/mdread

Read and edit markdown files in the browser, with encrypted share links and live co-editing.

Deploy to CloudflareView source

What it sets up in your account

  • KV
    KV namespace
    A key value store for settings and fast lookups.
  • DO
    Durable Objects
    Keeps live sessions and realtime state.
Category
Notes
Licence
MIT
Stars
25
Last commit
12 days ago

Use it with AI or code

  • Markdown for AIPaste into ChatGPT, Claude or any LLM./apps/mdread.md
    Open
  • JSON APIFree, no key, CORS open./api/v1/apps/mdread.json
    Open

More in the API docs and llms.txt.

Keeping it up to date

The Deploy button copies the repo into your GitHub. Run this in your copy whenever a new version comes out.

terminal
git remote add upstream https://github.com/techjewel/mdread.git
git pull upstream main
npx wrangler deploy

mdread questions

What is mdread?

Read and edit markdown files in the browser, with encrypted share links and live co-editing. It runs on Cloudflare Workers in your own account.

What does mdread set up in my Cloudflare account?

KV namespace and Durable Objects. They are created in your account, so the data stays yours.

How do I deploy mdread?

Press Deploy to Cloudflare. Cloudflare copies the repository into your GitHub account, creates what it needs and deploys it with Workers Builds.

Is mdread free and open source?

Yes. It’s published under the MIT licence. Running it uses your own Cloudflare account, and small setups usually fit in the free plan.

How do I update mdread?

Pull from the original repository and redeploy: add https://github.com/techjewel/mdread.git as an upstream remote, run git pull upstream main, then npx wrangler deploy.