<![endif]--></head> <body class=homepage> <div class="navbar navbar-default navbar-fixed-top" role=navigation> <div class=container> <!-- Collapsed navigation --> <div class=navbar-header> <!-- Expander button --> <button type=button class=navbar-toggle data-toggle=collapse data-target=.navbar-collapse> <span class=sr-only>Toggle navigation</span> <span class=icon-bar></span> <span class=icon-bar></span> <span class=icon-bar></span> </button> <!-- Main title --> <a class=navbar-brand href=.>MarkdownEditing</a> </div> <!-- Expanded navigation --> <div class="navbar-collapse collapse"> <!-- Main navigation --> <ul class="nav navbar-nav"> <li class=active> <a href=.>Home</a> </li> <li> <a href=install/ >Installation</a> </li> <li> <a href=usage/ >Usage</a> </li> <li> <a href=linting/ >Linting</a> </li> <li> <a href=config/ >Configuration</a> </li> <li> <a href=troubleshooting/ >Troubleshooting</a> </li> </ul> <ul class="nav navbar-nav navbar-right"> <li class=disabled> <a rel=prev> <i class="fas fa-arrow-left"></i> Previous </a> </li> <li> <a href=install/ rel=next> Next <i class="fas fa-arrow-right"></i> </a> </li> <li> <a href=https://github.com/SublimeText-Markdown/MarkdownEditing/edit/master/docs/index.md><i class="fab fa-github"></i> Edit on GitHub</a> </li> </ul> </div> </div> </div> <div class=container> <div class=col-md-3><div class="bs-sidebar hidden-print affix well" role=complementary> <ul class="nav bs-sidenav"> <li class="first-level active"><a href=#markdownediting>MarkdownEditing</a></li> <li class=second-level><a href=#features>Features</a></li> <li class=third-level><a href=#folding-and-navigation>Folding and Navigation</a></li> <li class=third-level><a href=#headings>Headings</a></li> <li class=third-level><a href=#lists>Lists</a></li> <li class=third-level><a href=#blockquotes>Blockquotes</a></li> <li class=third-level><a href=#critic-markup>Critic Markup</a></li> <li class=third-level><a href=#links-and-references>Links and References</a></li> <li class=third-level><a href=#text-formatting>Text Formatting</a></li> </ul> </div></div> <div class=col-md-9 role=main> <h1 id=markdownediting>MarkdownEditing</h1> <p><strong>Markdown plugin for Sublime Text</strong></p> <p><img alt=MarkdownEditing src=img/preview.png></p> <p>with...</p> <ul> <li>useful Markdown editing features for Sublime Text</li> <li>color schemes optimized for writing</li> <li>robust syntax definitions for<ul> <li>Standard Markdown</li> <li><a href=https://github.github.com/gfm>Github flavoured Markdown</a></li> <li><a href=https://fletcherpenney.net/multimarkdown>MultiMarkdown</a></li> </ul> </li> </ul> <p>ⓘ <em>See <a href=config/#change-color-scheme>configuration</a> section to learn how to change the color scheme</em>.</p> <div class="admonition note"> <p class=admonition-title>Most features are available through Command Palette.</p> <ol> <li>Open Command Palette <kbd>ctrl</kbd> + <kbd>shift</kbd> + <kbd>P</kbd> (Windows, Linux) or <kbd>⌘</kbd> + <kbd>⇧</kbd> + <kbd>P</kbd> (on Mac)</li> <li>Type <code>MarkdownEditing:</code> to display a list of available commands.</li> </ol> <p>ⓘ <em>They are only visible if a markdown file is open and focused.</em></p> </div> <h2 id=features>Features</h2> <h3 id=folding-and-navigation>Folding and Navigation</h3> <ul> <li>displays headings in <em>Goto Symbol...</em></li> <li>displays headings in <em>Goto Symbol in Project...</em></li> <li>fold current section</li> <li>fold by heading levels</li> <li>navigate between adjacent headings with <code>Find Next/Previous Heading</code> command.</li> </ul> <h3 id=headings>Headings</h3> <ul> <li>automatic detection and maintenance of open or closed <a href=usage/#atx-style>atx headings</a> style while typing</li> <li>change <a href=usage/#headings-levels>headings levels</a> via key bindings</li> <li>auto-complete <a href=usage/#setext-style>Setext-style headings</a> underlines</li> <li>convert <a href=usage/#setext-style>Setext-style headings</a> to ATX headings</li> <li>new documents are named automatically based on first header</li> </ul> <h3 id=lists>Lists</h3> <ul> <li>At the end of a list item, pressing <kbd>Enter</kbd> will automatically insert the new list item bullet.</li> <li>Pressing <kbd>Tab</kbd> on the blank list item will indent it and switch the list bullet to another one (Order is <code>*</code>, <code>-</code>, <code>+</code> in a cycle).</li> <li>Pressing <kbd>Shift</kbd> + <kbd>Tab</kbd> on the blank list item will unindent it in the same way as above.</li> <li>Sequential <kbd>Tab</kbd> s or <kbd>Shift</kbd> <kbd>Tab</kbd> s are supported.</li> <li>You can disable automatic bullet switching or choose which bullets to be used, in your settings file (<code>mde.list_indent_bullets</code>).</li> <li>If a list item contains a <a href=https://github.github.com/gfm/#task-list-items-extension->GFM Task</a>, pressing <ul> <li><kbd>Enter</kbd> at the end of the line continues with a new blank task.</li> <li><kbd>Alt+X</kbd> in the line toggles the check mark.</li> </ul> </li> </ul> <h3 id=blockquotes>Blockquotes</h3> <ul> <li>At the end of a blockquote line, pressing <kbd>Enter</kbd> will automatically extend blockquote.</li> <li>Selecting some text and pressing <kbd>></kbd> will convert it to blockquote. The first and the last line don't have to be fully selected; partial select works, too.</li> </ul> <h3 id=critic-markup>Critic Markup</h3> <ul> <li>Syntax highlighting for inline critic markup<ul> <li><code>{++ addition ++}</code></li> <li><code>{>> comment <<}</code></li> <li><code>{-- deletion --}</code></li> <li><code>{== highlight==}{>> comment <<}</code></li> <li><code>{~~ substitution ~> by ~~}</code></li> </ul> </li> <li>Reviewers can add critic via key bindings</li> <li>Authors can accept or reject critic via key bindings</li> </ul> <h3 id=links-and-references>Links and References</h3> <ul> <li>Left bracket pairing is modified to eliminate the selection and leave the cursor at a point where you can insert a <code>[]</code> or <code>()</code> pair for a link.</li> <li>URL part of images, links and references is automatically folded if caret is not within brackets</li> <li>Convert inline links to references</li> <li>Jump between definitions and references</li> <li>Organize references</li> <li>Add or remove footnotes</li> </ul> <h3 id=text-formatting>Text Formatting</h3> <ul> <li>Asterisks (<kbd>*</kbd>), backticks (<kbd>`</kbd>) and underscores (<kbd>_</kbd>) are auto-paired and wrap selected text</li> <li><kbd>~</kbd> wraps selected text with <code>~~</code> (strike-through)</li> <li><kbd>Backspace</kbd> deletes an empty pair</li> <li><kbd>Space</kbd> or <kbd>Tab</kbd> deletes right element of empty pair of asterisks or underscores</li> </ul></div> </div> <footer class="col-md-12 text-center"> <hr> <p> <small>Documentation built with <a href=http://www.mkdocs.org/ >MkDocs</a>.</small> </p> </footer> <script src=//ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js></script> <script src=js/bootstrap-3.0.3.min.js></script> <script src=//cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.18.0/build/highlight.min.js></script> <script>hljs.initHighlightingOnLoad();</script> <script>var base_url = "."</script> <script src=js/base.js></script> <div class=modal id=mkdocs_keyboard_modal tabindex=-1 role=dialog aria-labelledby=keyboardModalLabel aria-hidden=true> <div class=modal-dialog> <div class=modal-content> <div class=modal-header> <h4 class=modal-title id=keyboardModalLabel>Keyboard Shortcuts</h4> <button type=button class=close data-dismiss=modal><span aria-hidden=true>×</span><span class=sr-only>Close</span></button> </div> <div class=modal-body> <table class=table> <thead> <tr> <th style="width: 20%;">Keys</th> <th>Action</th> </tr> </thead> <tbody> <tr> <td class="help shortcut"><kbd>?</kbd></td> <td>Open this help</td> </tr> <tr> <td class="next shortcut"><kbd>n</kbd></td> <td>Next page</td> </tr> <tr> <td class="prev shortcut"><kbd>p</kbd></td> <td>Previous page</td> </tr> <tr> <td class="search shortcut"><kbd>s</kbd></td> <td>Search</td> </tr> </tbody> </table> </div> <div class=modal-footer> </div> </div> </div> </div> </body> </html> <!--
0 commit comments