Merge branch 'master' of github.com:benweet/stackedit

This commit is contained in:
benweet 2013-09-03 17:14:09 +01:00
commit 90e8573864
2 changed files with 32 additions and 16 deletions

View File

@ -3,6 +3,11 @@ StackEdit
StackEdit is a free, open-source Markdown editor based on PageDown, the Markdown library used by Stack Overflow and the other Stack Exchange sites.
> **NOTE:**
>
> - Documents are stored in the [browser's local storage][1], which means they are not shared between different browsers/computers. Furthermore, 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
@ -30,20 +35,16 @@ StackEdit is a free, open-source Markdown editor based on PageDown, the Markdown
### Documentation:
- [Welcome document][1]
- [Developer guide][2]
- [Theming guide][3]
### Note:
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. Your passwords
and credentials are never transmitted to a server and only stay in your browser locally.
> **NOTE:** This page has been written and published with [StackEdit][4].
- [Welcome document][2]
- [Developer guide][3]
- [Theming guide][4]
[1]: https://github.com/benweet/stackedit/blob/master/WELCOME.md#welcome-to-stackedit---welcome "Welcome document"
[2]: https://github.com/benweet/stackedit/blob/master/doc/developer-guide.md#developer-guide "Developer guide"
[3]: https://github.com/benweet/stackedit/blob/master/doc/theming.md#stackedit-theming-guide "Theming guide"
[4]: http://benweet.github.io/stackedit/ "StackEdit"
> **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/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]: http://benweet.github.io/stackedit/ "StackEdit"

View File

@ -29,6 +29,13 @@ You can rename the current document by clicking the document title in the naviga
You can delete the current document by clicking the <i class="icon-trash"></i> button in the navigation bar.
#### <i class="icon-hdd"></i> Save a document
You can save the current document to a file using the <i class="icon-hdd"></i> `Save as...` sub-menu.
> **NOTE:** See [<i class="icon-share"></i> Publish a document](#publish-a-document) section for a description of the different outputs.
----------
@ -37,6 +44,9 @@ Synchronization
**StackEdit** can be combined with **Google Drive** and **Dropbox** to have your documents centralized in the *Cloud*. The synchronization mechanism will take care of uploading your modifications or downloading the latest version of your documents.
> **NOTE:** Full access to **Google Drive** or **Dropbox** 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.
#### <i class="icon-download"></i> Import a document
You can import a document from the *Cloud* by going to the <i class="icon-provider-gdrive"></i> `Google Drive` or the <i class="icon-provider-dropbox"></i> `Dropbox` sub-menu and by clicking `Import from...`. Once imported, your document will be automatically synchronized with the **Google Drive** / **Dropbox** file.
@ -79,7 +89,7 @@ You can publish your document by going to the <i class="icon-share"></i> `Publis
- HTML, to publish the document converted into HTML (on a blog for instance),
- Template, to have a full control of the output.
> **NOTE:** The default template is a simple webpage that wraps your document in HTML format. You can customize it in the `Publish` tab of the <i class="icon-cog"></i> `Settings` dialog.
> **NOTE:** The default template is a simple webpage wrapping your document in HTML format. You can customize it in the `Publish` tab of the <i class="icon-cog"></i> `Settings` dialog.
#### <i class="icon-share"></i> Update a publication
@ -192,6 +202,11 @@ $$
\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.
$$
> **NOTE:** When exporting, make sure you include MathJax to render mathematical expression correctly. Your page/template should include something like:
```
<script type="text/javascript" src="http://benweet.github.io/stackedit/lib/MathJax/MathJax.js?config=TeX-AMS_HTML"></script>
```
> **NOTE:** You can find more information:
>