markdown-toc

https://github.com/ardumont/markdown-toc.git

git clone 'git://github.com/ardumont/markdown-toc.git'


---

markdown-toc

Table of Contents

• Use
  • Create
  • Update
  • Create elsewhere
• Install
  • emacs package repository
    • Setup
      • melpa stable
      • melpa
      • marmalade
    • Install
  • emacs-lisp file
• Inspiration

A simple mode to create TOC in a markdown file.

Use

Create

Inside a markdown file, the first time, place yourself where you want to insert the TOC:

M-x markdown-toc-generate-toc

This will compute the TOC and insert it at current position.

Here is one possible output:

<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-generate-toc again -->
**Table of Contents**

- [Use](#use)
    - [Create](#create)
    - [Update](#update)
    - [Create elsewhere](#create-elsewhere)
- [Install](#install)
    - [emacs package repository](#emacs-package-repository)
        - [Setup](#setup)
            - [melpa stable](#melpa-stable)
            - [melpa](#melpa)
            - [marmalade](#marmalade)
        - [Install](#install)
    - [emacs-lisp file](#emacs-lisp-file)
- [Inspiration](#inspiration)

Update

To update the existing TOC, simply execute again: C-u M-x markdown-toc-generate-toc

This will update the current TOC.

Create elsewhere

To create another updated TOC elsewhere, execute again M-x markdown-toc-generate-toc, this will remove the old TOC and insert the updated one from where you stand.

Install

emacs package repository

You need to add melpa or melpa-stable package repository before installing it.

Setup

melpa stable

(require 'package)
(add-to-list 'package-archives '("melpa-stable" . "http://melpa-stable.milkbox.net/packages/"))
(package-initialize)

Then hit M-x eval-buffer to evaluate the buffer's contents.

melpa

(require 'package)
(add-to-list 'package-archives '("melpa" . "http://melpa.milkbox.net/packages/"))
(package-initialize)

Then hit M-x eval-buffer to evaluate the buffer's contents.

marmalade

(require 'package)
(add-to-list 'package-archives '("marmalade" . "http://marmalade-repo.org/packages/"))
(package-initialize)

Install

M-x package-install RET markdown-toc RET

emacs-lisp file

Retrieve the markdown-toc.el https://github.com/ardumont/markdown-toc/releases.

Then hit M-x package-install-file RET markdown-toc.el RET

Inspiration

https://github.com/thlorenz/doctoc

The problem I had with doctoc is the installation process. I do not want to install the node tools just for this.