https://github.com/nonk123/sanity-emacs
Sanity live-server for GNU/Emacs
https://github.com/nonk123/sanity-emacs
emacs live-server sanity
Last synced: 17 days ago
JSON representation
Sanity live-server for GNU/Emacs
- Host: GitHub
- URL: https://github.com/nonk123/sanity-emacs
- Owner: nonk123
- License: unlicense
- Created: 2025-11-19T13:48:05.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2025-11-19T18:08:50.000Z (8 months ago)
- Last Synced: 2025-11-19T20:08:26.729Z (8 months ago)
- Topics: emacs, live-server, sanity
- Language: Emacs Lisp
- Homepage:
- Size: 11.7 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sanity-emacs
Rudimentary [sanity live-server](https://github.com/nonk123/sanity) support for GNU/Emacs.
## Installation
If you're using `use-package` and [`straight.el`](https://github.com/radian-software/straight.el), just add the following to your init-file:
```elisp
(use-package sanity
:straight (:type git :host github :repo "nonk123/sanity-emacs")
:custom (sanity-mode 1))
```
Automated installation with a different package-manager should be trivial to derive from the snippet above: just point yours to [this GitHub repo](https://github.com/nonk123/sanity-emacs).
## Usage
Make sure to customize the following variables:
- `sanity-mode`: enable this to auto-start `sanity` inside projects that contain a `www` directory. It is a global minor-mode.
Then try the following commands, available for/at your convenience:
- `M-x sanity-install`: auto-install the live-server to `~/.emacs.d/sanity/sanity`. `.exe` extension is appended on Windose.
- `M-x sanity-mode`: toggle `sanity-mode`, which auto-starts `sanity` inside supported projects.
- `M-x sanity-run`: manually run the live-server, prompting to auto-install it if it's missing.
- `M-x sanity-stop`: stop the live-server. More convenient to call this than to kill the process-buffer manually.