Stackedit/README.md

48 lines
1.7 KiB
Markdown
Raw Normal View History

2017-10-03 18:43:14 +00:00
# StackEdit
2017-07-23 18:42:08 +00:00
2018-02-11 12:32:16 +00:00
[![Build Status](https://img.shields.io/travis/benweet/stackedit.svg?style=flat)](https://travis-ci.org/benweet/stackedit) [![NPM version](https://img.shields.io/npm/v/stackedit.svg?style=flat)](https://www.npmjs.org/package/stackedit)
2017-10-03 18:43:14 +00:00
StackEdit is a full-featured, open-source Markdown editor based on PageDown, the Markdown library used by Stack Overflow and the other Stack Exchange sites.
2017-07-23 18:42:08 +00:00
2018-01-04 23:09:55 +00:00
https://stackedit.io/.
2017-10-03 18:43:14 +00:00
### StackEdit can:
2018-01-04 23:09:55 +00:00
- Manage multiple Markdown files online or offline
- Export your files in Markdown, HTML, PDF, Word, EPUB...
- Synchronize your Markdown files in the Cloud
- Edit existing Markdown files from Google Drive, Dropbox and your local hard drive
- Post your Markdown file on Blogger/Blogspot, WordPress, Zendesk
- Publish your Markdown file on GitHub, Gist, Google Drive, Dropbox
- Share a workspace over Google Drive
2017-10-03 18:43:14 +00:00
### Features:
2018-01-04 23:09:55 +00:00
- Real-time HTML preview with Scroll Sync feature to bind editor and preview scrollbars
- Markdown Extra/GitHub Flavored Markdown support and Prism.js syntax highlighting
- LaTeX mathematical expressions using KaTeX
- Diagrams and flowcharts using Mermaid
2017-10-03 18:43:14 +00:00
- WYSIWYG control buttons
2018-01-04 23:09:55 +00:00
- Smart layout
2017-10-03 18:43:14 +00:00
- Offline editing
2018-01-04 23:09:55 +00:00
- Online synchronization using Google Drive, Dropbox and GitHub
- One click publish to Blogger, Dropbox, Gist, GitHub, Google Drive, WordPress, Zendesk
2017-10-03 18:43:14 +00:00
### Build Setup
2017-07-23 18:42:08 +00:00
``` bash
# install dependencies
2018-01-14 16:27:06 +00:00
npm install
2017-07-23 18:42:08 +00:00
# serve with hot reload at localhost:8080
2018-01-14 16:27:06 +00:00
npm start
2017-07-23 18:42:08 +00:00
# build for production with minification
2018-01-14 16:27:06 +00:00
npm run build
2017-07-23 18:42:08 +00:00
# build for production and view the bundle analyzer report
2018-01-14 16:27:06 +00:00
npm run build --report
2017-07-23 18:42:08 +00:00
```
2018-01-04 23:09:55 +00:00
> **NOTE:** This page has been written and published with [StackEdit](https://stackedit.io/ "StackEdit").