postdown/README.md

postdown

A web-based, shareable, self-hosted Markdown editor built with deno

Demo

Visit https://post.jerryliao.cn

Deployment

You can deploy the project with docker by using Dockerfile in this repo to build a docker image or use Deno Deploy officially recommended in this doc

Development

Install deno runtime according to this doc, then run the setup task to install dependencies and enable git hooks:

deno task setup

Start the dev server and visit localhost:8000:

deno task dev

Available tasks

• deno task dev - Start the development server
• deno task test - Run all tests (backend + UI)
• deno task check - Check formatting, linting, and types
• deno task setup - Install dependencies and configure git hooks

Git hooks

A pre-commit hook is configured via .githooks/ to automatically format staged files and run tests before each commit. If auto-formatting fails, the commit is aborted. The deno task setup command enables this by setting core.hooksPath to .githooks/.