https://github.com/xuchunyang/elisp-docstring-server.el

An HTTP server for Emacs Lisp Docstring
https://github.com/xuchunyang/elisp-docstring-server.el

emacs

Last synced: 3 months ago
JSON representation

An HTTP server for Emacs Lisp Docstring

• Host: GitHub
• URL: https://github.com/xuchunyang/elisp-docstring-server.el
• Owner: xuchunyang
• License: gpl-3.0
• Created: 2020-10-28T17:03:53.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-09-15T04:20:17.000Z (over 3 years ago)
• Last Synced: 2024-08-01T03:43:18.361Z (5 months ago)
• Topics: emacs
• Language: Emacs Lisp
• Homepage:
• Size: 61.5 KB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Emacs Lisp Docstring Server

elisp-docstring-server.el provides a web server for Emacs Lisp Docstring.

![screenshot of the website](2020-10-29-screenshot.png)

the above screenshot is showing https://elisp-docstring.xuchunyang.me/?q=car

## Usage

1. M-x elisp-docstring-server-start

2. http://localhost:3000

### Run in Docker

1. execute `docker build -t elisp-docstring-server .` to build the image

2. execute `docker run --name elisp-docstring-server -d -p 3000:3000 elisp-docstring-server` to run the container

3. Browse `http://localhost:3000`

4. execute `docker exec elisp-docstring-server emacsclient -e "(require 'url-http)"` to load extra libraries

## Demo

![is elisp-docstring.xuchunyang.me down?](https://github.com/xuchunyang/elisp-docstring-server.el/workflows/is%20elisp-docstring.xuchunyang.me%20down%3F/badge.svg)

https://elisp-docstring.xuchunyang.me/

Emacs => Varnish (for cache) => Caddy (for HTTPS)

## Requires

- Emacs 25.1 or later

- https://github.com/eschulte/emacs-web-server (M-x package-install web-server)