Skip to content

Commit b40a410

Browse files
committed
Updated readme
1 parent f7c09ee commit b40a410

File tree

1 file changed

+51
-8
lines changed

1 file changed

+51
-8
lines changed

README.md

Lines changed: 51 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,64 @@
1-
# my-project
1+
# StackEdit
22

3-
> A Vue.js project
3+
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.
44

5-
## Build Setup
5+
Main showcase: https://stackedit.io/.
6+
7+
Support StackEdit:
8+
9+
[![](https://cdn.monetizejs.com/resources/button-32.png)](https://monetizejs.com/authorize?client_id=ESTHdCYOi18iLhhO&summary=true)
10+
11+
> **Note:**
12+
>
13+
> - 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.
14+
> - 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.
15+
16+
### StackEdit can:
17+
18+
- Manage multiple Markdown documents online or offline
19+
- Export your documents in Markdown, HTML or PDF and format it using a template
20+
- Synchronize your Markdown documents in the Cloud
21+
- Edit existing Markdown documents from Google Drive, Dropbox and your local hard drive
22+
- Post your Markdown document on Blogger/Blogspot, WordPress, Tumblr
23+
- Publish your Markdown document on GitHub, Gist, Google Drive, Dropbox or any SSH server
24+
- Share a link to a Markdown document that renders it in a nice viewer
25+
- Show statistics about your document
26+
- Convert HTML to Markdown
27+
28+
### Features:
29+
30+
- Real-time HTML preview with Scroll Link feature to bind editor and preview scrollbars
31+
- Markdown Extra/GitHub Flavored Markdown support and Prettify/Highlight.js syntax highlighting
32+
- LaTeX mathematical expressions using MathJax
33+
- WYSIWYG control buttons
34+
- Configurable layout
35+
- Theming support with different themes available
36+
- A la carte extensions
37+
- Offline editing
38+
- Online synchronization using Google Drive (multi-accounts) and Dropbox
39+
- One click publish on Blogger, Dropbox, Gist, GitHub, Google Drive, SSH server, Tumblr, WordPress
40+
41+
### Build Setup
642

743
``` bash
844
# install dependencies
9-
npm install
45+
yarn install
1046

1147
# serve with hot reload at localhost:8080
12-
npm run dev
48+
yarn start
1349

1450
# build for production with minification
15-
npm run build
51+
yarn run build
1652

1753
# build for production and view the bundle analyzer report
18-
npm run build --report
54+
yarn run build --report
1955
```
2056

21-
For detailed explanation on how things work, checkout the [guide](http://vuejs-templates.github.io/webpack/) and [docs for vue-loader](http://vuejs.github.io/vue-loader).
57+
> **NOTE:** This page has been written and published with [StackEdit][5].
58+
59+
60+
[1]: https://developer.mozilla.org/en-US/docs/Web/Guide/DOM/Storage#localStorage
61+
[2]: https://github.com/benweet/stackedit/blob/master/public/res/WELCOME.md#welcome-to-stackedit---welcome "Welcome document"
62+
[3]: https://github.com/benweet/stackedit/blob/master/doc/developer-guide.md#developer-guide "Developer guide"
63+
[4]: https://github.com/benweet/stackedit/blob/master/doc/theming.md#stackedit-theming-guide "Theming guide"
64+
[5]: https://stackedit.io/ "StackEdit"

0 commit comments

Comments
 (0)