caojiezi2003/Stackedit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Published with https://stackedit.io/

Browse Source
This commit is contained in:
Benoit Schweblin 2014-01-21 16:02:43 -08:00
parent efb8516c8a
commit 50cdd31f3c
1 changed files with 26 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
public/res/WELCOME.md
View File

@ -10,13 +10,17 @@ Hello, I am your first Markdown document within **StackEdit**[^stackedit]. Don't
Documents
---------
**StackEdit** stores your documents in your browser local storage, which means all your documents are automatically saved locally and are accessible offline.
**StackEdit** stores your documents in your browser, which means all your documents are automatically saved locally and are accessible **offline!**
> **NOTE:** This also means that your documents are not shared between different browsers or computers and that clearing your browser's data may **delete all of them!**
> **NOTE:**
>
> - StackEdit is accessible offline after the application has been loaded for the first time.
> - Your local documents are not shared between different browsers or computers.
> - Clearing your browser's data may **delete all your local documents!** Make sure your documents are backed up using **Google Drive** or **Dropbox** synchronization (see [<i class="icon-share"></i> Synchronization](#synchronization) section).
#### <i class="icon-file"></i> Create a document
You can create a new document by clicking the <i class="icon-file"></i> button in the navigation bar. This will switch from the current document to the new one.
You can create a new document by clicking the <i class="icon-file"></i> button in the navigation bar. It will switch from the current document to the new one.
#### <i class="icon-folder-open"></i> Switch to another document
@ -32,9 +36,9 @@ You can delete the current document by clicking the <i class="icon-trash"></i> b
#### <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.
You can save the current document to a file using the <i class="icon-hdd"></i> `Save as...` sub-menu from the <i class="icon-provider-stackedit"></i> menu.
> **NOTE:** See [<i class="icon-share"></i> Publish a document](#publish-a-document) section for a description of the different outputs.
> **Tip:** See [<i class="icon-share"></i> Publish a document](#publish-a-document) section for a description of the different output formats.
----------
@ -59,17 +63,15 @@ You can import a document from the *Cloud* by going to the <i class="icon-provid
You can export any document 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 `Export to...`. Even if your document is already synchronized with **Google Drive** or **Dropbox**, you can export it to a another location. **StackEdit** can synchronize one document with multiple locations.
> **Tip:** Using **Google Drive**, you can create collaborative documents to work in real time with multiple users on the same document. Just check the box `Create a real time collaborative document` in the dialog options when exporting to Google Drive.
#### <i class="icon-refresh"></i> Synchronize a document
Once your document is linked to a **Google Drive** or a **Dropbox** file, **StackEdit** will periodically (every 3 minutes) synchronize it by downloading/uploading any modification. Any conflict will be detected, and a local copy of your document will be created as a backup if necessary.
If you just have modified your document and you want to force the synchronization, click the <i class="icon-refresh"></i> button in the navigation bar.
> **NOTE:** The <i class="icon-refresh"></i> button is disabled when:
>
> - you are offline,
> - or the document is not synchronized with any location,
> - or the document has not been modified since the last synchronization.
> **NOTE:** The <i class="icon-refresh"></i> button is disabled when you have no document to synchronize.
#### <i class="icon-refresh"></i> Manage document synchronization
@ -99,16 +101,13 @@ You can publish your document by going to the <i class="icon-share"></i> `Publis
After publishing, **StackEdit** will keep your document linked to that publish location so that you can update it easily. Once you have modified your document and you want to update your publication, click on the <i class="icon-share"></i> button in the navigation bar.
> **NOTE:** The <i class="icon-share"></i> button is disabled when:
>
> - you are offline,
> - or the document has not been published anywhere.
> **NOTE:** The <i class="icon-share"></i> button is disabled when the document has not been published yet.
#### <i class="icon-share"></i> Manage document publication
Since one document can be published on multiple locations, you can list and manage publish locations by clicking <i class="icon-share"></i> `Manage publication` in the <i class="icon-provider-stackedit"></i> menu. This will open a dialog box allowing you to remove publication links that are associated to your document.
> **NOTE:** In some cases, if you remove the file from the website or the post from the blog, the document will no longer be published on that location.
> **NOTE:** In some cases, if the file has been removed from the website or the blog, the document will no longer be published on that location.
----------
@ -118,7 +117,7 @@ Markdown Extra
**StackEdit** supports **Markdown Extra**, which extends **Markdown** syntax with some nice features.
> **NOTE:** You can disable any **Markdown Extra** feature in the `Extensions` tab of the <i class="icon-cog"></i> `Settings` dialog.
> **Tip:** You can disable any **Markdown Extra** feature in the `Extensions` tab of the <i class="icon-cog"></i> `Settings` dialog.
### Tables
@ -160,27 +159,14 @@ Term 3
### Fenced code blocks
GitHub's fenced code blocks are also supported with **Prettify** syntax highlighting:
GitHub's fenced code blocks[^gfm] are also supported with **Prettify** syntax highlighting:
```
// Foo
var bar = 0;
```
> **NOTE:** To use **Highlight.js** instead of **Prettify**, just configure the `Markdown Extra` extension in the <i class="icon-cog"></i> `Settings` dialog.
### Special Attributes
With **Markdown Extra**, you can specify `class` and `id` attributes on headers and fenced code blocks just like this:
##### Header example {#my-header}
``` {#my-id .my-class}
var foo = bar;
```
Then you can create cross-references like this: [beginning of the document](#welcome).
> **Tip:** To use **Highlight.js** instead of **Prettify**, just configure the `Markdown Extra` extension in the <i class="icon-cog"></i> `Settings` dialog.
### Footnotes
@ -208,6 +194,12 @@ You can insert a table of contents using the marker `[TOC]`:
[TOC]
### Comments
Usually, comments in Markdown are just standard HTML comments. <!-- like this -->
**StackEdit** extends HTML comments in order to produce useful, highlighted comments in the preview but not in your exported documents. <!--- This is very useful for collecting feedback from other users in a collaborative document. -->
### MathJax
You can render *LaTeX* mathematical expressions using **MathJax**, as on [math.stackexchange.com][1]:
@ -219,7 +211,7 @@ $$
\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:
> **Tip:** Make sure you include MathJax into your publications to render mathematical expression correctly. Your page/template should include something like:
```
<script type="text/javascript" src="https://stackedit.io/libs/MathJax/MathJax.js?config=TeX-AMS_HTML"></script>
@ -233,9 +225,9 @@ $$
> - about **Prettify** syntax highlighting [here][5],
> - about **Highlight.js** syntax highlighting [here][6].
Written with [StackEdit](https://stackedit.io/).
[^stackedit]: [StackEdit](https://stackedit.io/) 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]: StackEdit is a free, open-source Markdown editor based on PageDown, the Markdown library used by Stack Overflow and the other Stack Exchange sites.
[^gfm]: **GitHub Flavored Markdown** (GFM) is supported by StackEdit.
[1]: http://math.stackexchange.com/