Updated readme
This commit is contained in:
parent
4b9bb3b833
commit
1b79c739d3
51
README.md
51
README.md
@ -2,41 +2,29 @@
|
|||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
Main showcase: https://stackedit.io/.
|
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:
|
### StackEdit can:
|
||||||
|
|
||||||
- Manage multiple Markdown documents online or offline
|
- Manage multiple Markdown files online or offline
|
||||||
- Export your documents in Markdown, HTML or PDF and format it using a template
|
- Export your files in Markdown, HTML, PDF, Word, EPUB...
|
||||||
- Synchronize your Markdown documents in the Cloud
|
- Synchronize your Markdown files in the Cloud
|
||||||
- Edit existing Markdown documents from Google Drive, Dropbox and your local hard drive
|
- Edit existing Markdown files from Google Drive, Dropbox and your local hard drive
|
||||||
- Post your Markdown document on Blogger/Blogspot, WordPress, Tumblr
|
- Post your Markdown file on Blogger/Blogspot, WordPress, Zendesk
|
||||||
- Publish your Markdown document on GitHub, Gist, Google Drive, Dropbox or any SSH server
|
- Publish your Markdown file on GitHub, Gist, Google Drive, Dropbox
|
||||||
- Share a link to a Markdown document that renders it in a nice viewer
|
- Share a workspace over Google Drive
|
||||||
- Show statistics about your document
|
|
||||||
- Convert HTML to Markdown
|
|
||||||
|
|
||||||
### Features:
|
### Features:
|
||||||
|
|
||||||
- Real-time HTML preview with Scroll Link feature to bind editor and preview scrollbars
|
- Real-time HTML preview with Scroll Sync feature to bind editor and preview scrollbars
|
||||||
- Markdown Extra/GitHub Flavored Markdown support and Prettify/Highlight.js syntax highlighting
|
- Markdown Extra/GitHub Flavored Markdown support and Prism.js syntax highlighting
|
||||||
- LaTeX mathematical expressions using MathJax
|
- LaTeX mathematical expressions using KaTeX
|
||||||
|
- Diagrams and flowcharts using Mermaid
|
||||||
- WYSIWYG control buttons
|
- WYSIWYG control buttons
|
||||||
- Configurable layout
|
- Smart layout
|
||||||
- Theming support with different themes available
|
|
||||||
- A la carte extensions
|
|
||||||
- Offline editing
|
- Offline editing
|
||||||
- Online synchronization using Google Drive (multi-accounts) and Dropbox
|
- Online synchronization using Google Drive, Dropbox and GitHub
|
||||||
- One click publish on Blogger, Dropbox, Gist, GitHub, Google Drive, SSH server, Tumblr, WordPress
|
- One click publish to Blogger, Dropbox, Gist, GitHub, Google Drive, WordPress, Zendesk
|
||||||
|
|
||||||
### Build Setup
|
### Build Setup
|
||||||
|
|
||||||
@ -54,11 +42,4 @@ yarn run build
|
|||||||
yarn run build --report
|
yarn run build --report
|
||||||
```
|
```
|
||||||
|
|
||||||
> **NOTE:** This page has been written and published with [StackEdit][5].
|
> **NOTE:** This page has been written and published with [StackEdit](https://stackedit.io/ "StackEdit").
|
||||||
|
|
||||||
|
|
||||||
[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"
|
|
||||||
|
Loading…
Reference in New Issue
Block a user