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, той же библиотеки Markdown, которую использует Stack Overflow.
Это онлайн-сайт, приложение для Chrome или то, что можно развернуть самостоятельно?Верно всё сразу: можно пользоваться онлайн-редактором прямо в браузере, установить его как приложение для Chrome или развернуть собственную копию (есть официальный образ Docker и чарт Helm для Kubernetes).
Как запустить собственную копию StackEdit?Проще всего просто пользоваться онлайн-редактором. Для самостоятельного развёртывания установите официальный чарт Helm в любой кластер Kubernetes. Его можно подключить к вашему существующему контроллеру Ingress и эмитенту cert-manager.
Работает ли это без подключения к интернету?Да, StackEdit сделан как прогрессивное веб-приложение (PWA), поэтому после загрузки он может продолжать работать офлайн.
В какие облачные сервисы можно синхронизировать или публиковать свои файлы?В список интеграций StackEdit входят Google Drive, Dropbox, GitHub, GitLab, Gist, CouchDB, WordPress, Blogger и Zendesk.
Что такое stackedit.js?Это вспомогательная библиотека, упомянутая в разделе об экосистеме, которая позволяет встроить редактор StackEdit непосредственно в любой сайт.
Есть ли также расширение для Chrome?Да, отдельное расширение для Chrome, построенное на основе stackedit.js, указано в экосистеме проекта рядом с приложением для Chrome.
Почему выбрали PageDown, а не другую библиотеку Markdown?PageDown — библиотека Markdown, которую используют Stack Overflow и остальная сеть Stack Exchange, поэтому у 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