https://github.com/xuchunyang/describe-symbol

https://github.com/xuchunyang/describe-symbol

documentation elisp emacs

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/xuchunyang/describe-symbol
• Owner: xuchunyang
• Created: 2020-11-01T14:02:56.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-11-11T15:07:05.000Z (about 4 years ago)
• Last Synced: 2024-08-01T03:43:13.691Z (5 months ago)
• Topics: documentation, elisp, emacs
• Language: Emacs Lisp
• Homepage: https://describe-symbol.vercel.app
• Size: 87.9 KB
• Stars: 14
• Watchers: 3
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Online Emacs Documentation

https://describe-symbol.vercel.app/

## About

Emacs 25.1 introduced C-h o (`describe-symbol`) which shows documentation for all kinds

of symbols, i.e., function/variable/face/cl-type, this project dumps all (about 10,000) Emacs's

builtin symbols' documentation using it and provides a web interface.

## Features

- Supports Emacs 25.1, 26.1 and 27.1

- Clickable links to source file, info manual etc, similar to Emacs

- Show code demo from [elisp-demos.el](https://github.com/xuchunyang/elisp-demos) alongside the docstring

- Autocomplete

## Build

### Database

To build the database:

1. Run `make json EMACS=25.1` to dump documentation into a JSON file.

2. Run `node add-elisp-demos-to-json.js` to add elisp-demos to the JSON file.

3. Run `node json-to-harperdb.js` to upload the JSON file to HarperDB, a `.env` file like the

   following will be required

```conf

DB_HOST=https://cloud-1-xuchunyang.harperdbcloud.com

DB_USER=fake_user

DB_PASS=fake_pass

SCHEMA=describe_symbol

```

### Website

To build the website, run `vercel dev`.

## Alternative

http://doc.endlessparentheses.com/ provides documentation for Emacs [25.0.50.2](http://doc.endlessparentheses.com/Var/emacs-version.html).