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)

helm
Searching Database…

23.1K ·GitHub
Stackedit
What is this?StackEdit is a full-featured, open-source Markdown editor that runs entirely in your browser, built on PageDown, the same Markdown library Stack Overflow uses.
Is this a hosted website, a Chrome app, or something I self-host?All three: you can use the hosted editor directly in your browser, install it as a Chrome app, or self-host your own instance (there's an official Docker image and Helm chart for Kubernetes).
How do I get my own StackEdit instance running?Easiest is to just use the hosted editor; to self-host, deploy the official Helm chart to any Kubernetes cluster, which you can wire up to your existing ingress controller and cert-manager issuer.
Does it work without an internet connection?Yes, StackEdit is set up as a Progressive Web App, so it can keep working offline once loaded.
Which cloud services can I sync or publish my files to?StackEdit's listed integrations include Google Drive, Dropbox, GitHub, GitLab, Gist, CouchDB, WordPress, Blogger, and Zendesk.
What is stackedit.js?It's a companion library, mentioned in the ecosystem section, that lets you embed the StackEdit editor directly into any website.
Is there a Chrome extension too?Yes, a separate Chrome extension built on top of stackedit.js is listed alongside the Chrome app in the project's ecosystem.
Why base it on PageDown instead of another Markdown library?PageDown is the Markdown library Stack Overflow and the rest of the Stack Exchange network use, giving StackEdit a proven, widely-used editing engine.
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