This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/layers/+lang/markdown
2015-10-25 11:01:08 +01:00
..
img Use + instead of ! for layer categories 2015-09-11 00:13:51 -04:00
config.el Use + instead of ! for layer categories 2015-09-11 00:13:51 -04:00
packages.el Restore alphabetical order in markdown doc 2015-10-25 11:01:08 +01:00
README.org Fix the list of buffer-wide commands in markdown 2015-10-25 10:51:19 +01:00

Markdown contribution layer for Spacemacs

/TakeV/spacemacs/media/commit/405dc6600d3ea51898ba4a3b1f72549d392a1cf0/layers/+lang/markdown/img/markdown.png

Description

This layer adds markdown support to Spacemacs.

Features:

  • markdown files support via markdown-mode
  • TOC generation via markdown-toc
  • Completion of Emojis using company-emoji (still needs a way of showing, either using the emoji layer or having a proper font) 👏

Install

To use this contribution add it to your ~/.spacemacs

  (setq-default dotspacemacs-configuration-layers '(markdown))

Usage

To generate a table of contents type on top of the buffer: SPC : markdown-toc/generate-toc RET

Key bindings

Element insertion

Key Binding Description
SPC m - insert horizontal line
SPC m h i insert header dwim
SPC m h I insert header setext dwim
SPC m h 1 insert header atx 1
SPC m h 2 insert header atx 2
SPC m h 3 insert header atx 3
SPC m h 4 insert header atx 4
SPC m h 5 insert header atx 5
SPC m h 6 insert header atx 6
SPC m h ! insert header setext 1
SPC m h @ insert header setext 2
SPC m i l insert link
SPC m i L insert reference link dwim
SPC m i u insert uri
SPC m i f insert footnote
SPC m i w insert wiki link
SPC m i i insert image
SPC m i I insert reference image
SPC m x b make region bold or insert bold
SPC m x i make region italic or insert italic
SPC m x c make region code or insert code
SPC m x C make region code or insert code (Github Flavored Markdown format)
SPC m x q make region blockquote or insert blockquote
SPC m x Q blockquote region
SPC m x p make region or insert pre
SPC m x P pre region

Element removal

Key Binding Description
SPC m k kill thing at point

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
gj outline forward same level
gk outline backward same level
gh outline up one level
gl outline next visible heading

Buffer-wide commands

Key Binding Description
SPC m c ] complete buffer
SPC m c m other window
SPC m c p preview
SPC m c e export
SPC m c v export and preview
SPC m c o open
SPC m c w kill ring save
SPC m c c check refs
SPC m c n cleanup list numbers
SPC m c r render buffer

List editing

Key Binding Description
SPC m l h promote
SPC m l i insert list item
SPC m l j move down
SPC m l k move up
SPC m l l demote

Movement

Key Binding Description
SPC m { backward paragraph
SPC m } forward paragraph
SPC m N next link
SPC m P previous link

Promotion, Demotion

Key Binding Description
M-k markdown-move-up
M-j markdown-move-down
M-h markdown-promote
M-l markdown-demote