This package parses an elisp file's comments, definitions,
docstrings, and other documentation into a hierarchical org-mode
buffer. It is intended to facilitate familiarization with a file's
contents and organization / structure. The viewer can quickly swoop
in and out and across the file structure using standard org-mode
commands and keybindings.
org
: For org-mode
(should be bundled in your Emacs already)
- Evaluate or load this file.
Interactive function M-x pkg-overview
prompts the user for an elisp
file, parses it according to generally accepted elisp formatting
conventions, and generates a read-only org-mode
buffer with the
results.
🏁 Note: If you haven't yet loaded feature org-mode
,
you will experience a delay the first time you evaluate function
pkg-overview
as it performs the load.
None.
Tested with Emacs 27.1 and org-mode
9.4.6. in Debian.
- Copyright © 2020-2021, Boruch Baum [email protected]
- Author/Maintainer: Boruch Baum [email protected]
- Homepage: https://github.com/Boruch-Baum/emacs-pkg-overview
- SPDX-License-Identifier: GPL-3.0-or-later
-
- Large collection of inter-operable dired extensions
- https://github.com/Boruch-Baum/emacs-diredc
-
Emacs-w3m
- Extensions to the classic web browser (fork)
- Advanced downloader (bulk, regex, queue management, resume aborted)
- Scrub history
- More ...
- https://github.com/Boruch-Baum/emacs-w3m
- Extensions to the classic web browser (fork)
-
- Download and play crossword puzzles, in Emacs!
- https://github.com/Boruch-Baum/emacs-crossword
-
- Highlight the cursor on buffer/window-switch
- https://github.com/Boruch-Baum/emacs-cursor-flash
-
- Center visual cross-hairs on POINT.
- https://github.com/Boruch-Baum/emacs-xhair
-
- Simple keybinding cheat-sheet and launcher
- https://github.com/Boruch-Baum/emacs-key-assist
-
- Turn home and end keys to multi-use navigation keys
- https://github.com/Boruch-Baum/emacs-home-end
-
- perform different actions when repeating a key
- https://github.com/Boruch-Baum/emacs-keypress-multi-event
-
Post-mode - Updates to the abandoned email editing package (fork)