https://github.com/xuchunyang/elisp-demos

Demonstrate Emacs Lisp APIs
https://github.com/xuchunyang/elisp-demos

Last synced: about 1 month ago
JSON representation

Demonstrate Emacs Lisp APIs

• Host: GitHub
• URL: https://github.com/xuchunyang/elisp-demos
• Owner: xuchunyang
• Created: 2018-11-12T13:17:42.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-01-28T08:10:46.000Z (11 months ago)
• Last Synced: 2024-10-16T01:45:55.360Z (3 months ago)
• Language: Emacs Lisp
• Homepage:
• Size: 741 KB
• Stars: 220
• Watchers: 11
• Forks: 25
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Elisp API Demos

[![Build Status](https://github.com/xuchunyang/elisp-demos/workflows/CI/badge.svg)](https://github.com/xuchunyang/elisp-demos/actions)

[![MELPA](https://melpa.org/packages/elisp-demos-badge.svg)](https://melpa.org/#/elisp-demos)

[![MELPA Stable](https://stable.melpa.org/packages/elisp-demos-badge.svg)](https://stable.melpa.org/#/elisp-demos)

Showing an Elisp demo of `mapcar` in `C-h f mapcar`:

![Elisp Demo: mapcar](screenshot.png)

## Usage

To inject elisp demos into `*Help*`, such as `C-h f` (`M-x describe-function`), use

``` emacs-lisp

(advice-add 'describe-function-1 :after #'elisp-demos-advice-describe-function-1)

```

If you use [Helpful](https://github.com/Wilfred/helpful), use

``` emacs-lisp

(advice-add 'helpful-update :after #'elisp-demos-advice-helpful-update)

```

## Contributing

Put your awesome Elisp demos into [elisp-demos.org](elisp-demos.org). A demo is simply an Org heading. Here is `mapcar`'s.

``` org

* mapcar

#+BEGIN_SRC elisp

(mapcar #'1+ '(1 2 3))

#+END_SRC

#+RESULTS:

: (2 3 4)

```

You can use `M-x elisp-demos-add-demo` to insert a new demo or edit an existing one.