|
|
@@ -1,3 +1,24 @@
|
|
|
# postdown
|
|
|
|
|
|
+<img align="right" src="https://git.jerryliao.cn/jerryliao/postdown/raw/main/static/postdown.png" height="128px" alt="the postdown logo designed by Chris Peng">
|
|
|
+
|
|
|
+[](https://cicd.jerryliao.cn/jerryliao/postdown)
|
|
|
+
|
|
|
A web-based, shareable, self-hosted Markdown editor built with deno
|
|
|
+
|
|
|
+## Demo
|
|
|
+
|
|
|
+Visit [https://post.jerryliao.cn](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](https://fresh.deno.dev/docs/getting-started/deploy-to-production)
|
|
|
+
|
|
|
+## Development
|
|
|
+
|
|
|
+Install `deno` runtime according to
|
|
|
+[this doc](https://docs.deno.com/runtime/manual), then execute `deno task start`
|
|
|
+in the project root, all the dependencies should be automatically installed.
|
|
|
+Then check `localhost:8000` in your browser for the website
|
