Welcome to StackEdit!
Hey! I’m your first Markdown document inStackEdit#fn:stackedit"id="fnref:stackedit"title="See footnote"class="footnote">1. Don’t delete me, I’m very helpful! I can be recovered anyway in theUtilstab of theSettingsdialog.
//www.youtube.com/embed/UiGhqP5LDYc"allowfullscreen="">
https://plot.ly/~Dreamshot/411.embed?width=640&height=480">
Documents
StackEdit stores your documents in your browser, which means all your documents are automatically saved locally and are accessibleoffline!
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 synchronized with
Google Drive
or
Dropbox
(check out the#synchronization">Synchronizationsection).
Create a document
The document panel is accessible using thebutton in the navigation bar. You can create a new document by clickingNew documentin the document panel.
Switch to another document
All your local documents are listed in the document panel. You can switch from one to another by clicking a document in the list or you can toggle documents usingCtrl+[andCtrl+].
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 clickingDelete documentin the document panel.
Export a document
You can save the current document to a file by clickingExport to diskfrom themenu panel.
Tip:Check out the#publish-a-document">Publish a documentsection for a description of the different output formats.
Synchronization
StackEdit can be combined withGoogle DriveandDropboxto have your documents saved in theCloud. The synchronization mechanism takes 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. Permission restrictions can be configured in the settings.
Imported documents are downloaded in your browser and are not transmitted to a server.
If you experience problems saving your documents on Google Drive, check and optionally disable browser extensions, such as Disconnect.
Open a document
You can open a document fromGoogle Driveor theDropboxby opening theSynchronizesub-menu and by clickingOpen from…. Once opened, any modification in your document will be automatically synchronized with the file in yourGoogle Drive/Dropboxaccount.
Save a document
You can save any document by opening theSynchronizesub-menu and by clickingSave on…. Even if your document is already synchronized withGoogle DriveorDropbox, you can export it to a another location. StackEdit can synchronize one document with multiple locations and accounts.
Synchronize a document
Once your document is linked to aGoogle Driveor aDropboxfile, StackEdit will periodically (every 3 minutes) synchronize it by downloading/uploading any modification. A merge will be performed if necessary and conflicts will be detected.
If you just have modified your document and you want to force the synchronization, click thebutton in the navigation bar.
Note:Thebutton is disabled when you have no document to synchronize.
Manage document synchronization
Since one document can be synchronized with multiple locations, you can list and manage synchronized locations by clickingManage synchronizationin theSynchronizesub-menu. This will let you remove synchronization locations that are associated to your document.
Note:If you delete the file fromGoogle Driveor fromDropbox, 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 onBlogger,Dropbox,Gist,GitHub,Google Drive,Tumblr,WordPressand on any SSH server.
Publish a document
You can publish your document by opening thePublishsub-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 example),
Template, to have a full control of the output.
Note:The default template is a simple webpage wrapping your document in HTML format. You can customize it in theAdvancedtab of theSettingsdialog.
Update a publication
After publishing, StackEdit will keep your document linked to that publication which makes it easy for you to update it. Once you have modified your document and you want to update your publication, click on thebutton in the navigation bar.
Note:Thebutton is disabled when your document has not been published yet.
Manage document publication
Since one document can be published on multiple locations, you can list and manage publish locations by clickingManage publicationin themenu panel. This will let you remove publication locations that are associated to your document.
Note:If the file has been removed from the website or the blog, the document will no longer be published on that location.
Markdown Extra
StackEdit supportsMarkdown Extra, which extendsMarkdownsyntax with some nice features.
Tip:You can disable anyMarkdown Extrafeature in theExtensionstab of theSettingsdialog.
Note:You can find more information aboutMarkdownsyntaxhttp://daringfireball.net/projects/markdown/syntax"title="Markdown">hereandMarkdown Extraextensionhttps://github.com/jmcmanus/pagedown-extra"title="Pagedown Extra">here.
Tables
Markdown Extrahas 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 Extrahas 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 withHighlight.jssyntax highlighting:
// Foo
varbar =0;
Tip:To usePrettifyinstead ofHighlight.js, just configure theMarkdown Extraextension in theSettingsdialog.
Note:You can find more information:
about
Prettify
syntax highlightinghttps://code.google.com/p/google-code-prettify/">here,
about
Highlight.js
syntax highlightinghttp://highlightjs.org/">here.
Footnotes
You can create footnotes like this#fn:footnote"id="fnref:footnote"title="See footnote"class="footnote">2.
SmartyPants
SmartyPants converts ASCII punctuation characters into “smart” typographic punctuation HTML entities. For example:
ASCII
HTML
Single backticks
'Isn't this fun?'
‘Isn’t this fun?’
Quotes
"Isn't this fun?"
“Isn’t this fun?”
Dashes
-- is en-dash, --- is em-dash
– is en-dash, — is em-dash
Table of contents
You can insert a table of contents using the marker[TOC]:
#welcome-to-stackedit">Welcome to StackEdit!
#documents">Documents
#create-a-document">Create a document
#switch-to-another-document">Switch to another document
#rename-a-document">Rename a document
#delete-a-document">Delete a document
#export-a-document">Export a document
#synchronization">Synchronization
#open-a-document">Open a document
#save-a-document">Save a document
#synchronize-a-document">Synchronize a document
#manage-document-synchronization">Manage document synchronization
#publication">Publication
#publish-a-document">Publish a document
#update-a-publication">Update a publication
#manage-document-publication">Manage document publication
#markdown-extra">Markdown Extra
#tables">Tables
#definition-lists">Definition Lists
#fenced-code-blocks">Fenced code blocks
#footnotes">Footnotes
#smartypants">SmartyPants
#table-of-contents">Table of contents
#mathjax">MathJax
#uml-diagrams">UML diagrams
#support-stackedit">Support StackEdit
MathJax
You can renderLaTeXmathematical expressions usingMathJax, as onhttp://math.stackexchange.com/">math.stackexchange.com:
TheGamma functionsatisfying\Gamma(n) = (n-1)!\quad\forall n\in\mathbb Nis via the Euler integral
\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.
Tip:To make sure mathematical expressions are rendered properly on your website, includeMathJaxinto your template:
Note:You can find more information aboutLaTeXmathematical expressionshttp://meta.math.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference">here.
UML diagrams
You can also render sequence diagrams like this:
Created with Raphaël 2.1.2AliceAliceBobBobHello Bob, how are you?Bob thinksI am good thanks!
And flow charts like this:
Created with Raphaël 2.1.2StartMy OperationYes or No?Endyesno
Note:You can find more information:
about
Sequence diagrams
syntaxhttp://bramp.github.io/js-sequence-diagrams/">here,
about
Flow charts
syntaxhttp://adrai.github.io/flowchart.js/">here.
Support StackEdit
https://monetizejs.com/authorize?client_id=ESTHdCYOi18iLhhO&summary=true">https://cdn.monetizejs.com/resources/button-32.png"alt=""title="">
https://stackedit.io/">StackEditis a full-featured, open-source Markdown editor based on PageDown, the Markdown library used by Stack Overflow and the other Stack Exchange sites.#fnref:stackedit"title="Return to article"class="reversefootnote">↩Here is the
text
of the
footnote
.#fnref:footnote"title="Return to article"class="reversefootnote">↩