aboutsummaryrefslogtreecommitdiff
docshack: Getting docs easy on Emacs

docshack: Getting docs easy on Emacs

Table of Contents

docshack is a set of tools to get docs for projects for Emacs browsing.

MDN

Requires markdown-mode.

You may use docshack to get MDN markdown docs for local browsing. To do so, first build the docs:

make mdn
make DESTDIR=~/docs install-mdn

Then add in your emacs init file (assuming you cloned docshack to ~/docshack).

(add-to-list 'load-path "~/docshack/lisp")
(require 'docshack-mdn)

Most of the internal links now work in mdn. A nice way to look up mdn is with an indexer, like recoll (an emacs client is org-recoll).

TODOs

  • [ ] JSxRef links don't work.

Contact and copyright

docshack is maintained by Yuchen Pei <id@ypei.org>, and covered by GNU AGPLv3+. You may find the license text in a file named COPYING.agpl3 in the project tree.