diff --git a/contrib/lang/markdown/README.md b/contrib/lang/markdown/README.md index 3e7420400..d8a3539b4 100644 --- a/contrib/lang/markdown/README.md +++ b/contrib/lang/markdown/README.md @@ -5,11 +5,20 @@ **Table of Contents** -- [Colors contribution layer for Spacemacs](#colors-contribution-layer-for-spacemacs) +- [Markdown contribution layer for Spacemacs](#markdown-contribution-layer-for-spacemacs) - [Description](#description) - [Install](#install) + - [Usage](#usage) - [Key bindings](#key-bindings) - - [Ledger](#ledger) + - [Element insertion](#element-insertion) + - [Element removal](#element-removal) + - [Promotion, Demotion, Completion, and Cycling](#promotion-demotion-completion-and-cycling) + - [Following and Jumping](#following-and-jumping) + - [Indentation](#indentation) + - [Header navigation](#header-navigation) + - [Buffer-wide commands](#buffer-wide-commands) + - [List editing](#list-editing) + - [Movement](#movement) @@ -36,7 +45,106 @@ To generate a table of contents type on top of the buffer: ## Key bindings -**TODO** +### Element insertion + + Key Binding | Description +----------------------|------------------------------------------------------------ +SPC m " | insert hr +SPC m a l | insert link +SPC m a L | insert reference link dwim +SPC m a u | insert uri +SPC m a f | insert footnote +SPC m a w | insert wiki link +SPC m i i | insert image +SPC m i I | insert reference image +SPC m t h | insert header dwim +SPC m t H | insert header setext dwim +SPC m t 1 | insert header atx 1 +SPC m t 2 | insert header atx 2 +SPC m t 3 | insert header atx 3 +SPC m t 4 | insert header atx 4 +SPC m t 5 | insert header atx 5 +SPC m t 6 | insert header atx 6 +SPC m t ! | insert header setext 1 +SPC m t @ | insert header setext 2 +SPC m s s | insert bold +SPC m s e | insert italic +SPC m s c | insert code +SPC m s b | insert blockquote +SPC m s B | blockquote region +SPC m s p | insert pre +SPC m s P | pre region + +### Element removal + + Key Binding | Description +----------------------|------------------------------------------------------------ +SPC m k | kill thing at point + +### Promotion, Demotion, Completion, and Cycling + + Key Binding | Description +----------------------|------------------------------------------------------------ +SPC m = | promote +SPC m - | demote +SPC m ] | complete + +### Following and Jumping + + Key Binding | Description +----------------------|------------------------------------------------------------ +SPC m o | follow thing at point +SPC m j | jump + +### Indentation + + Key Binding | Description +----------------------|------------------------------------------------------------ +SPC m \> | indent region +SPC m \< | exdent region + +### Header navigation + + Key Binding | Description +----------------------|------------------------------------------------------------ +SPC m n | outline next visible heading +SPC m p | outline previous visible heading +SPC m f | outline forward same level +SPC m b | outline backward same level +SPC m u | outline up heading + +### Buffer-wide commands + + Key Binding | Description +----------------------|------------------------------------------------------------ +SPC m c m | complete buffer +SPC m c p | other window +SPC m c e | preview +SPC m c v | export +SPC m c o | export and preview +SPC m c w | open +SPC m c c | kill ring save +SPC m c n | check refs +SPC m c ] | cleanup list numbers + +### List editing + + Key Binding | Description +----------------------|------------------------------------------------------------ +SPC m l k | move up +SPC m l j | move down +SPC m l h | promote +SPC m l l | demote +SPC m l i | insert list item + +### Movement + + Key Binding | Description +----------------------|------------------------------------------------------------ +SPC m { | backward paragraph +SPC m } | forward paragraph +SPC m N | next link +SPC m P | previous link [markdown-mode]: http://jblevins.org/git/markdown-mode.git/ [markdown-toc]: https://github.com/ardumont/markdown-toc diff --git a/contrib/lang/markdown/packages.el b/contrib/lang/markdown/packages.el index d8dcf8d55..00fb3d293 100644 --- a/contrib/lang/markdown/packages.el +++ b/contrib/lang/markdown/packages.el @@ -33,6 +33,7 @@ which require an initialization must be listed explicitly in the list.") (progn (evil-leader/set-key-for-mode 'markdown-mode ;; Element insertion + "m\"" 'markdown-insert-hr "mal" 'markdown-insert-link "maL" 'markdown-insert-reference-link-dwim "mau" 'markdown-insert-uri @@ -57,7 +58,6 @@ which require an initialization must be listed explicitly in the list.") "msB" 'markdown-blockquote-region "msp" 'markdown-insert-pre "msP" 'markdown-pre-region - "m\"" 'markdown-insert-hr ;; Element removal "mk" 'markdown-kill-thing-at-point ;; Promotion, Demotion, Completion, and Cycling @@ -77,6 +77,7 @@ which require an initialization must be listed explicitly in the list.") "mb" 'outline-backward-same-level "mu" 'outline-up-heading ;; Buffer-wide commands + "mc]" 'markdown-complete-buffer "mcm" 'markdown-other-window "mcp" 'markdown-preview "mce" 'markdown-export @@ -85,7 +86,6 @@ which require an initialization must be listed explicitly in the list.") "mcw" 'markdown-kill-ring-save "mcc" 'markdown-check-refs "mcn" 'markdown-cleanup-list-numbers - "mc]" 'markdown-complete-buffer ;; List editing "mlk" 'markdown-move-up "mlj" 'markdown-move-down