https://github.com/fuco1/elisp-docstring-mode

Major mode for editing elisp docstrings
https://github.com/fuco1/elisp-docstring-mode

docstring documentation emacs emacs-lisp

Last synced: 25 days ago
JSON representation

Major mode for editing elisp docstrings

• Host: GitHub
• URL: https://github.com/fuco1/elisp-docstring-mode
• Owner: Fuco1
• Created: 2017-03-04T13:10:36.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-03-13T15:24:40.000Z (almost 8 years ago)
• Last Synced: 2025-01-11T08:04:52.332Z (about 1 month ago)
• Topics: docstring, documentation, emacs, emacs-lisp
• Language: Emacs Lisp
• Size: 54.7 KB
• Stars: 12
• Watchers: 4
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# elisp-docstring-mode

A simple major-mode for editing content of Emacs Lisp docstrings.  Very useful in combination with [string-edit](https://github.com/magnars/string-edit.el).

# Features

Provides font-lock.  In combination with string-edit, there is support for automatic escaping and unescaping of quotes.

Here is a comparison of the string as a docstring in `emacs-lisp-mode` and as a string in a `string-edit` buffer (with `elisp-docstring-mode` enabled).

![demo](images/demo.png)