Elisp2any

Project links: repository, mirror, RubyGems.org.

Installation

Install the gem and add to the application's Gemfile by executing bundle add elisp2any. If Bundler is not being used to manage dependencies, install the gem by executing gem install elisp2any.

Usage

Currently the command line tool supports HTML (default) and JSON rendering.

$ elisp2any --input /path/to/input/file --output /path/to/output/file

The JSON is based off the Pandoc JSON filter. The example usage is:

./exe/elisp2any \
    --format=json \
    < ~/.emacs.d/init.el \
    | pandoc \
          --from=json \
          --standalone \
          > /tmp/index.html

Development

To run tests, run test-unit (or rake test).

There are a few notes about the terms.

Two paragraph types:

;; This is a major one.

;; This is another major one (1), and a minor one.
;;
;; This is still (1) but another minor one.

Heading levels:

;;; Level 2
;;;; Level 3

Contributing

Bug reports and pull requests are welcome.

License

Copyright (C) 2025, 2026 gemmaro

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.