diff options
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/README.org b/README.org new file mode 100644 index 0000000..aa8f144 --- /dev/null +++ b/README.org @@ -0,0 +1,36 @@ +#+title: docshack: Getting docs easy on Emacs + +docshack is a set of tools to get docs for projects for Emacs +browsing. + +* MDN + +Requires [[https://elpa.nongnu.org/nongnu/markdown-mode.html][markdown-mode]]. + +You may use docshack to get MDN markdown docs for local browsing. To +do so, first build the docs: + +#+begin_src sh +make mdn +make DESTDIR=~/docs install-mdn +#+end_src + +Then add in your emacs init file (assuming you cloned docshack to +~~/docshack~). + +#+begin_src elisp +(add-to-list 'load-path "~/docshack/lisp") +(require 'docshack-mdn) +#+end_src + +Most of the internal links now work in mdn. A nice way to look up mdn +is with an indexer, like [[https://lesbonscomptes.com/recoll/pages/index-recoll.html][recoll]] (an emacs client is [[https://github.com/alraban/org-recoll][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. |