Skip to content

Commit

Permalink
update commands in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
felixhao28 committed Jul 27, 2016
1 parent a6d4fc4 commit 1b5f54b
Showing 1 changed file with 41 additions and 2 deletions.
43 changes: 41 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,9 @@ The preferred method of installation is via [Sublime Package Control][wbond].
| <kbd>⌘</kbd><kbd>⌥</kbd><kbd>V</kbd> | <kbd>Ctrl</kbd><kbd>Win</kbd><kbd>V</kbd> | Creates or pastes the contents of the clipboard as an inline link on selected text.
| <kbd>⌘</kbd><kbd>⌥</kbd><kbd>R</kbd> | <kbd>Ctrl</kbd><kbd>Win</kbd><kbd>R</kbd> | Creates or pastes the contents of the clipboard as a reference link.
| <kbd>⌘</kbd><kbd>⇧</kbd><kbd>K</kbd> | <kbd>Shift</kbd><kbd>Win</kbd><kbd>K</kbd> | Creates or pastes the contents of the clipboard as an inline image on selected text.
| <kbd>⌘</kbd><kbd>⌥</kbd><kbd>B</kbd> <kbd>⌘</kbd><kbd>⌥</kbd><kbd>I</kbd> | <kbd>Ctrl</kbd><kbd>Shift</kbd><kbd>B</kbd> <kbd>Ctrl</kbd><kbd>Shift</kbd><kbd>I</kbd> | These are bound to bold and italic. They work both with and without selections. If there is no selection, they will just transform the word under the cursor. These keybindings will unbold/unitalicize selection if it is already bold/italic.
| <kbd>⌘</kbd><kbd>⌥</kbd><kbd>B</kbd> <kbd>⌘</kbd><kbd>⌥</kbd><kbd>I</kbd> | <kbd>Alt</kbd><kbd>B</kbd> <kbd>Alt</kbd><kbd>I</kbd> | These are bound to bold and italic. They work both with and without selections. If there is no selection, they will just transform the word under the cursor. These keybindings will unbold/unitalicize selection if it is already bold/italic.
| <kbd>⌘</kbd><kbd>^</kbd><kbd>1...6</kbd> | <kbd>Ctrl</kbd><kbd>1...6</kbd> | These will add the corresponding number of hashmarks for headlines. Works on blank lines and selected text in tandem with the above headline tools. If you select an entire existing headline, the current hashmarks will be removed and replaced with the header level you requested. This command respects the `mde.match_header_hashes` preference setting.
| <kbd>⌥</kbd><kbd>⇧</kbd><kbd>6</kbd> | <kbd>Alt</kbd><kbd>Shift</kbd><kbd>6</kbd> | Inserts a footnote.
| <kbd>⌘</kbd><kbd>^</kbd><kbd>S</kbd> | <kbd>Ctrl</kbd><kbd>Alt</kbd><kbd>S</kbd> | Organizes references and footnotes.

## GFM Specific Features

Expand Down Expand Up @@ -126,6 +125,46 @@ Performs lint on current Markdown file. See [lint rules](lint_docs/RULES.md). So

Switches the highlighted list between numbered and bulleted style.

### Magic Footnotes Command

Adds a footnote after the word under cursor. If cursor is already on a footnote, jumps to its definition or reference.

### Gather Missing Footnotes

Add definition stubs (if there is none) for all footnotes references.

### Jump Reference

Jumps cursor between definitions and references.

### New Reference

Adds a new link under cursor.

### New Inline Link

Adds a new inline link under cursor.

### New Inline Image

Adds a new inline image under cursor.

### New Image

Adds a new image under cursor.

### New Footnote

Adds a footnote under cursor.

### Delete Reference

Deletes the definition and references of a link.

### Organize References

Sorts and gives a report on current link references usage.

## Configuration

The plugin contains 3 different Markdown flavors: Standard Markdown, GitHub flavored Markdown, MultiMarkdown. Default is GitHub flavored Markdown. If you want to set another one as default, open a Markdown file and select your flavor from the menu: `View > Syntax > Open all with current extension as`. You're done.
Expand Down

0 comments on commit 1b5f54b

Please sign in to comment.