TakeV/spacemacs
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
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
History
Maximilian Wolff b96ace1313
[markdown] Remove obsolete orgtbl-mode cleanup 
for it has a lot of side effects by globally replacing
-+- in the entire markdown buffer. Up to now markdown
has its own table insert function available via
`SPC i T` which is to be prefered.

In addition there seems to be no active
binding for `orgtbl-mode` in markdown making it very
unlikely that someone is still using it within markdown-mode.
2021-05-29 23:33:13 +02:00
..
img
config.el Apply GPLv3 terms explicitly to all elisp files 2021-03-25 22:59:32 -04:00
funcs.el [markdown] Remove obsolete orgtbl-mode cleanup 2021-05-29 23:33:13 +02:00
packages.el [markdown] Remove obsolete orgtbl-mode cleanup 2021-05-29 23:33:13 +02:00
README.org [markdown] Add binding for inserting common tables 2021-05-29 23:10:51 +02:00

README.org

Markdown layer

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

Description

This layer adds markdown support to Spacemacs.

Features:

BibTeX

For more extensive support of references with BibTeX files, have a look at the BibTeX layer.

Install

To use this configuration layer, add it to your ~/.spacemacs. You will need to add markdown to the existing dotspacemacs-configuration-layers list in this file.

Configuration

Live preview

A live preview can be generated when one of these executables are in path:

  • markdown
  • pandoc
  • markdown_py

A well-knowned markdown command is from https://daringfireball.net/projects/markdown/. Or follow pandoc installation instructions to install pandoc into path: https://pandoc.org/installing.html

Another choice is installing Python-Markdown:

  pip install --user Markdown

If your markdown executable is not in the list, please refer the document of markdown-mode for customizing the markdown-command.

Another alternative is to install the `github layer` and use `grip-mode` for live previewing, though this only supports Github flavored markdown.

By default the built-in Emacs web browser is used to live preview a markdown buffer.

To use vmd (GitHub-flavored live preview) instead set the value of the variable markdown-live-preview-engine to vmd:

  dotspacemacs-configuration-layers '(
    (markdown :variables markdown-live-preview-engine 'vmd))

And install the executable with:

  npm install -g vmd

Additionally there is flymd package in chrome layer that allows to preview markdown buffer in Chrome. Please refer to chrome layer documentation for more information.

Automatic MMM-Mode Generation

To generate MMM-Modes for languages set the value of the variable markdown-mmm-auto-modes to a list of the languages. For languages where the mode name directly relates to the language name, use a string. Otherwise, use a list of `("language" "mode")`:

  dotspacemacs-configuration-layers '(
    (markdown :variables markdown-mmm-auto-modes '("c" "c++" "python" "scala" ("elisp" "emacs-lisp"))))

Note: Spacemacs already defines the variable markdown-mmm-auto-modes to a bunch of languages. Consider opening a PR on the Spacemacs repository to add new languages instead of overriding the variable in your dotfile.

Usage

Generate a TOC

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

Editing tables

While markdown-mode provides functionality to edit tables, users of org layer benefit from more sophisticated orgtbl-mode.

In order to use orgtabl-mode, add org layer to your ~/.spacemacs.

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 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 t insert Table of Contents (toc)
SPC m i T insert general markdown table
SPC m x b make region bold or insert bold
SPC m x B insert gfm checkbox
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 k make region <kbd> element or insert <kbd> element
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
SPC m x s make region striked through or insert strikethrough

Element removal

Key binding Description
SPC m k kill thing at point

Table manipulation

Key binding Description
SPC m t p move row up
SPC m t n move row down
SPC m t f move column right
SPC m t b move column left
SPC m t r insert row
SPC m t R delete row
SPC m t c insert column
SPC m t C delete column
SPC m t s sort lines
SPC m t t transpose table
SPC m t d convert region to table

Completion

Key binding Description
SPC m ] complete

Following and Jumping

Key binding Description
SPC m o follow thing at point
RET jump (markdown-do)

Indentation

Key binding Description
SPC m > indent region
SPC m < outdent 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 P live preview using engine defined with layer variable markdown-live-preview-engine
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 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

Promotion, Demotion

Key binding Command
M-k or M-up markdown-move-up
M-j or M-down markdown-move-down
M-h or M-left markdown-promote
M-l or M-right markdown-demote

Toggles

Key binding Description
SPC m T i toggle inline images
SPC m T l toggle hidden urls
SPC m T m toggle markup hiding
SPC m T t toggle checkbox
SPC m T w toggle wiki links