Stackedit/README.md

65 lines
2.7 KiB
Markdown
Raw Normal View History

2017-10-03 18:43:14 +00:00
# StackEdit
2017-07-23 18:42:08 +00:00
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
2017-10-03 18:43:14 +00:00
Main showcase: https://stackedit.io/.
Support StackEdit:
[![](https://cdn.monetizejs.com/resources/button-32.png)](https://monetizejs.com/authorize?client_id=ESTHdCYOi18iLhhO&summary=true)
> **Note:**
>
> - Documents are stored in the [browser's local storage][1], which means they are not shared between different browsers/computers. Clearing your browser's data may delete all your local documents.
> - Full access to Dropbox or Google Drive is required to be able to import any document in StackEdit. Imported documents are downloaded in your browser and are not transmitted to a server.
### StackEdit can:
- Manage multiple Markdown documents online or offline
- Export your documents in Markdown, HTML or PDF and format it using a template
- Synchronize your Markdown documents in the Cloud
- Edit existing Markdown documents from Google Drive, Dropbox and your local hard drive
- Post your Markdown document on Blogger/Blogspot, WordPress, Tumblr
- Publish your Markdown document on GitHub, Gist, Google Drive, Dropbox or any SSH server
- Share a link to a Markdown document that renders it in a nice viewer
- Show statistics about your document
- Convert HTML to Markdown
### Features:
- Real-time HTML preview with Scroll Link feature to bind editor and preview scrollbars
- Markdown Extra/GitHub Flavored Markdown support and Prettify/Highlight.js syntax highlighting
- LaTeX mathematical expressions using MathJax
- WYSIWYG control buttons
- Configurable layout
- Theming support with different themes available
- A la carte extensions
- Offline editing
- Online synchronization using Google Drive (multi-accounts) and Dropbox
- One click publish on Blogger, Dropbox, Gist, GitHub, Google Drive, SSH server, Tumblr, WordPress
### Build Setup
2017-07-23 18:42:08 +00:00
``` bash
# install dependencies
2017-10-03 18:43:14 +00:00
yarn install
2017-07-23 18:42:08 +00:00
# serve with hot reload at localhost:8080
2017-10-03 18:43:14 +00:00
yarn start
2017-07-23 18:42:08 +00:00
# build for production with minification
2017-10-03 18:43:14 +00:00
yarn run build
2017-07-23 18:42:08 +00:00
# build for production and view the bundle analyzer report
2017-10-03 18:43:14 +00:00
yarn run build --report
2017-07-23 18:42:08 +00:00
```
2017-10-03 18:43:14 +00:00
> **NOTE:** This page has been written and published with [StackEdit][5].
[1]: https://developer.mozilla.org/en-US/docs/Web/Guide/DOM/Storage#localStorage
[2]: https://github.com/benweet/stackedit/blob/master/public/res/WELCOME.md#welcome-to-stackedit---welcome "Welcome document"
[3]: https://github.com/benweet/stackedit/blob/master/doc/developer-guide.md#developer-guide "Developer guide"
[4]: https://github.com/benweet/stackedit/blob/master/doc/theming.md#stackedit-theming-guide "Theming guide"
[5]: https://stackedit.io/ "StackEdit"