An Emacs mode for creating a table of contents in markdown files.
Table of Contents
This package provides three interactive functions:
| Function | Binding | Description |
|---|---|---|
markdown-toc-generate |
C-c m g | Create a toc at point |
markdown-toc-refresh |
C-c m r | Find and update an existing toc |
markdown-toc-follow-link |
C-c m . | Jump to a section from the toc |
You can transform the structure of the ToC using markdown-toc-transform-fn. It
defaults to the identity function (no transformation).
It expects as argument the toc-structure markdown-toc uses to generate the toc. The remaining code expects a similar structure.
Example:
'((0 . "H1 Document Title")
(0 . "Another H1 heading")
(1 . "H2 heading")
(2 . "H3 heading")
(1 . "H2 heading")
(0 . "H1 heading")
(1 . "H2 heading"))The car of each item is a heading level; the cdr of each item is the heading text.
The first element is often a document title. To drop the title from the table of
contents, set markdown-toc-transform-fn to a function that removes the first
element from a list:
(setq markdown-toc-transform-fn 'cdr)Or drop all h1 titles:
(require 'dash)
(custom-set-variables
'(markdown-toc-transform-fn
(lambda (toc-structure)
(-filter
(lambda (l) (let ((index (car l)))
(<= 1 index)))
toc-structure)))The following variables can be customized. They are shown here with their defaults.
(setq
markdown-toc-start "<!-- toc start -->"
markdown-toc-end "<!-- toc end -->"
markdown-toc-title "**Table of Contents**"
markdown-toc-indent 2
markdown-toc-transform-fn (lambda (x) x))markdown-toc-mode is a minor mode with the following default key bindings:
(setq markdown-toc-mode-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "C-c m .") 'markdown-toc-follow-link)
(define-key map (kbd "C-c m d") 'markdown-toc-delete)
map))To (de)activate this in an org file: /M-x markdown-toc-mode/
Run tests:
cask install
cask exec ert-runner