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.
StackEdit stores your documents in the browser local storage, which means all your documents are automatically saved locally and are accessible offline.
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.
You can list all your local documents and switch from one to another by clicking the button in the navigation bar.
You can rename the current document by clicking the document title in the navigation bar.
You can delete the current document by clicking the button in the navigation bar.
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.
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.
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.
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.
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.
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.
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 theSettings
dialog.
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.
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.
StackEdit supports Markdown Extra, which extends Markdown syntax with some nice features.
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 |
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
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 theSettings
dialog.
With Markdown Extra, you can specify class
and id
attributes on headers and fenced code blocks just like this:
var foo = bar;
Then you can create cross-references like this: beginning of the document.
You can create footnotes like this2.
You can insert a table of contents using the marker [TOC]
:
[TOC]
You can render LaTeX mathematical expressions using MathJax, as on math.stackexchange.com:
The Gamma function satisfying
NOTE: You can find more information: