You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is a paragraph, which is text surrounded by whitespace. Paragraphs can be on one
line (or many), and can drone on for hours.
Here is a Markdown link to Warped, and a literal .
Now some SimpleLinks, like one to [google] (automagically links to are-you-
feeling-lucky), a [wiki: test] link to a Wikipedia page, and a link to
[foldoc: CPU]s at foldoc.
Now some inline markup like italics, bold, and code(). Note that underscores in
words are ignored in Markdown Extra.
Blockquotes are like quoted text in email replies
And, they can be nested
Bullet lists are easy too
Another one
Another one
A numbered list
Which is numbered
With periods and a space
And now some code:
// Code is just text indented a bit
which(is_easy) to_remember();
// Markdown extra adds un-indented code blocks too
if (this_is_more_code == true && !indented) {
// tild wrapped code blocks, also not indented
}
Text with
two trailing spaces
(on the right)
can be used
for things like poems
Horizontal rules
This is a div wrapping some Markdown plus. Without the DIV attribute, it ignores the
block.
Markdown plus tables
Header
Header
Right
Cell
Cell
$10
Cell
Cell
$20
Outer pipes on tables are optional
Colon used for alignment (right versus left)
Markdown plus definition lists
Bottled water
: $ 1.25
: $ 1.55 (Large)
Milk
Pop
: $ 1.75
Multiple definitions and terms are possible
Definitions can include multiple paragraphs too
*[ABBR]: Markdown plus abbreviations (produces an tag)
Hello, I am your first Markdown document within StackEdit1. Don't delete me, I can be helpful. I can be recovered anyway in the Utils tab of the Settings dialog.
Documents
StackEdit stores your documents in the browser local storage, which means all your documents are automatically saved locally and are accessible offline.
Create a document
You can create a new document by clicking the button in the navigation bar. This will switch from the current document to the new one.
Switch to another document
You can list all your local documents and switch from one to another by clicking the button in the navigation bar.
Rename a document
You can rename the current document by clicking the document title in the navigation bar.
Delete a document
You can delete the current document by clicking the button in the navigation bar.
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.
Import a document
You can import a document from the Cloud by going to the Google Drive or the Dropbox sub-menu and by clicking Import from.... Once imported, your document will be automatically synchronized with the Google Drive / Dropbox file.
Export a document
You can export any document by going to the Google Drive or the 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.
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 button in the navigation bar.
NOTE: The 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.
Manage document synchronization
Since one document can be synchronized with multiple locations, you can list and manage synchronized locations by clicking Manage synchronization in the menu. This will open a dialog box allowing you to add or remove synchronization links that are associated to your document.
NOTE: If you delete the file from Google Drive or from Dropbox, the document will no longer be synchronized with that location.
Publication
Once you are happy with your document, you can publish it on different websites directly from StackEdit. As for now, StackEdit can publish on Blogger, Dropbox, Gist, GitHub, Google Drive, Tumblr, WordPress and on any SSH server.
Publish a document
You can publish your document by going to the Publish on sub-menu and by choosing a website. In the dialog box, you can choose the publication format:
Markdown, to publish the Markdown text on a website that can interpret it (GitHub for instance),
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 Settings dialog.
Update a publication
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 button in the navigation bar.
NOTE: The button is disabled when:
you are offline,
or the document has not been published anywhere.
Manage document publication
Since one document can be published on multiple locations, you can list and manage publish locations by clicking Manage publication in the 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.
Markdown Extra
StackEdit supports Markdown Extra, which extends Markdown syntax with some nice features.
Tables
Markdown Extra has a special syntax for tables:
Item
Value
Computer
$1600
Phone
$12
Pipe
$1
You can specify column alignment with one or two colons:
Item
Value
Qty
Computer
$1600
5
Phone
$12
12
Pipe
$1
234
Definition Lists
Markdown Extra has a special syntax for definition lists too:
Term 1
Term 2
: Definition A
: Definition B
Term 3
: Definition C
: Definition D
> part of definition D
Fenced code blocks
GitHub's fenced code blocks 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 Settings dialog.
Special Attributes
With Markdown Extra, you can specify class and id attributes on headers and fenced code blocks just like this:
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Hello, I am your first Markdown document within **StackEdit**[^stackedit]. Don't delete me, I can be helpful. I can be recovered anyway in the `Utils` tab of the <i class="icon-cog"></i> `Settings` dialog.
----------
Documents
---------
**StackEdit** stores your documents in the browser local storage, which means all your documents are automatically saved locally and are accessible offline.
#### <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.
#### <i class="icon-folder-open"></i> Switch to another document
You can list all your local documents and switch from one to another by clicking the <i class="icon-folder-open"></i> button in the navigation bar.
#### <i class="icon-pencil"></i> Rename a document
You can rename the current document by clicking the document title in the navigation bar.
#### <i class="icon-trash"></i> Delete a document
You can delete the current document by clicking the <i class="icon-trash"></i> button in the navigation bar.
----------
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.
#### <i class="icon-download"></i> Import a document
You can import a document from the *Cloud* by going to the <i class="icon-gdrive"></i> `Google Drive` or the <i class="icon-dropbox"></i> `Dropbox` sub-menu and by clicking `Import from...`. Once imported, your document will be automatically synchronized with the **Google Drive** / **Dropbox** file.
#### <i class="icon-upload"></i> Export a document
You can export any document by going to the <i class="icon-gdrive"></i> `Google Drive` or the <i class="icon-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.
#### <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.
Since one document can be synchronized with multiple locations, you can list and manage synchronized locations by clicking <i class="icon-refresh"></i> `Manage synchronization` in the <i class="icon-stackedit"></i> menu. This will open a dialog box allowing you to add or remove synchronization links that are associated to your document.
> **NOTE:** If you delete the file from **Google Drive** or from **Dropbox**, the document will no longer be synchronized with that location.
----------
Publication
-----------
Once you are happy with your document, you can publish it on different websites directly from **StackEdit**. As for now, **StackEdit** can publish on **Blogger**, **Dropbox**, **Gist**, **GitHub**, **Google Drive**, **Tumblr**, **WordPress** and on any SSH server.
#### <i class="icon-share"></i> Publish a document
You can publish your document by going to the <i class="icon-share"></i> `Publish on` sub-menu and by choosing a website. In the dialog box, you can choose the publication format:
- Markdown, to publish the Markdown text on a website that can interpret it (**GitHub** for instance),
- 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.
#### <i class="icon-share"></i> Update a publication
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.
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-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.
----------
Markdown Extra
--------------
**StackEdit** supports **Markdown Extra**, which extends **Markdown** syntax with some nice features.
### Tables
**Markdown Extra** has a special syntax for tables:
Item | Value
--------- | -----
Computer | \$1600
Phone | \$12
Pipe | \$1
You can specify column alignment with one or two colons:
| Item | Value | Qty |
| :-------- | ------:| :--: |
| Computer | \$1600 | 5 |
| Phone | \$12 | 12 |
| Pipe | \$1 | 234 |
### Definition Lists
**Markdown Extra** has a special syntax for definition lists too:
Term 1
Term 2
: Definition A
: Definition B
Term 3
: Definition C
: Definition D
> part of definition D
### Fenced code blocks
**GitHub**'s fenced code blocks 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).
### Footnotes
You can create footnotes like this[^footnote].
[^footnote]: Here is the *text* of the **footnote**.
### Table of contents
You can insert a table of contents using the marker `[TOC]`:
[TOC]
### MathJax
You can render *LaTeX* mathematical expressions using **MathJax**, as on [math.stackexchange.com][1]:
The *Gamma function* satisfying $\Gamma(n) = (n-1)!\quad\forall
n\in\mathbb N$ is via through the Euler integral
$$
\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.
$$
> **NOTE:** You can find more information:
>
> - about **Markdown** syntax [here][2],
> - about **Markdown Extra** extension [here][3],
> - about **Prettify** syntax highlighting [here][4].
> - about **Highlight.js** syntax highlighting [here][5].
[^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.
