stackedit README

The project's README from github.com/benweet/stackedit. As one markdown file: README.md.

StackEdit

Build Status NPM version

Full-featured, open-source Markdown editor based on PageDown, the Markdown library used by Stack Overflow and the other Stack Exchange sites.

https://stackedit.io/

Ecosystem

Build

# install dependencies
npm install

# serve with hot reload at localhost:8080
npm start

# build for production with minification
npm run build

# build for production and view the bundle analyzer report
npm run build --report

Deploy with Helm

StackEdit Helm chart allows easy StackEdit deployment to any Kubernetes cluster. You can use it to configure deployment with your existing ingress controller and cert-manager.

# Add the StackEdit Helm repository
helm repo add stackedit https://benweet.github.io/stackedit-charts/

# Update your local Helm chart repository cache
helm repo update

# Deploy StackEdit chart to your cluster
helm install --name stackedit stackedit/stackedit \
  --set dropboxAppKey=$DROPBOX_API_KEY \
  --set dropboxAppKeyFull=$DROPBOX_FULL_ACCESS_API_KEY \
  --set googleClientId=$GOOGLE_CLIENT_ID \
  --set googleApiKey=$GOOGLE_API_KEY \
  --set githubClientId=$GITHUB_CLIENT_ID \
  --set githubClientSecret=$GITHUB_CLIENT_SECRET \
  --set wordpressClientId=\"$WORDPRESS_CLIENT_ID\" \
  --set wordpressSecret=$WORDPRESS_CLIENT_SECRET

Later, to upgrade StackEdit to the latest version:

helm repo update
helm upgrade stackedit stackedit/stackedit

If you want to uninstall StackEdit:

helm delete --purge stackedit

If you want to use your existing ingress controller and cert-manager issuer:

# See https://docs.cert-manager.io/en/latest/tutorials/acme/quick-start/index.html
helm install --name stackedit stackedit/stackedit \
  --set dropboxAppKey=$DROPBOX_API_KEY \
  --set dropboxAppKeyFull=$DROPBOX_FULL_ACCESS_API_KEY \
  --set googleClientId=$GOOGLE_CLIENT_ID \
  --set googleApiKey=$GOOGLE_API_KEY \
  --set githubClientId=$GITHUB_CLIENT_ID \
  --set githubClientSecret=$GITHUB_CLIENT_SECRET \
  --set wordpressClientId=\"$WORDPRESS_CLIENT_ID\" \
  --set wordpressSecret=$WORDPRESS_CLIENT_SECRET \
  --set ingress.enabled=true \
  --set ingress.annotations."kubernetes\.io/ingress\.class"=nginx \
  --set ingress.annotations."cert-manager\.io/cluster-issuer"=letsencrypt-prod \
  --set ingress.hosts[0].host=stackedit.example.com \
  --set ingress.hosts[0].paths[0]=/ \
  --set ingress.tls[0].secretName=stackedit-tls \
  --set ingress.tls[0].hosts[0]=stackedit.example.com

stackedit (benweet/stackedit)

Searching Database…

23.1K ·GitHub
Stackedit
这是什么？StackEdit 是一款功能完善的开源 Markdown 编辑器，完全在浏览器中运行，基于 PageDown 构建。PageDown 也是 Stack Overflow 使用的 Markdown 库。
这是托管网站、Chrome 应用，还是我需要自己部署的程序？三种都支持：你可以直接在浏览器中使用托管版编辑器，把它安装为 Chrome 应用，或者自托管自己的实例（项目提供官方 Docker 镜像和用于 Kubernetes 的 Helm chart）。
我怎样才能运行自己的 StackEdit 实例？最简单的方法是直接使用托管版编辑器。如需自托管，可以将官方 Helm chart 部署到任意 Kubernetes 集群，并与你现有的 Ingress 控制器和 cert-manager Issuer 连接。
没有网络连接也能用吗？可以。StackEdit 采用渐进式 Web 应用（PWA）构建，页面加载完成后即可离线继续使用。
我可以把文件同步或发布到哪些云服务？StackEdit 列出的集成包括 Google Drive、Dropbox、GitHub、GitLab、Gist、CouchDB、WordPress、Blogger 和 Zendesk。
stackedit.js 是什么？它是一个配套库，在生态系统部分有所提及，可以把 StackEdit 编辑器直接嵌入到任何网站中。
还有 Chrome 扩展程序吗？有。在项目的生态系统中，除了 Chrome 应用，还列出了一个基于 stackedit.js 构建的独立 Chrome 扩展程序。
为什么基于 PageDown，而不是其他 Markdown 库？PageDown 是 Stack Overflow 及整个 Stack Exchange 网络所使用的 Markdown 库，让 StackEdit 拥有经过验证、被广泛使用的编辑引擎。
What are similar projects?rxdb, marp, chatwoot, md, dashy, verdaccio, harbor, apowerb
Which topics is it in?google-drive, dropbox, gitlab, helm-charts, wordpress, markdown-editor, helm, pwa, editor, github, vue, offline
Creator
benweet
Size
36.6 MB
Stars
23.1K
Updated
CommitMay 27Releasev5.14.0Jul 02
Age
13y
Commits · 90 Days