MLX-CL/DEV/ELISP
Emacs functionalities for developping MLX-CL
Table of Contents
1. About
MLX-CL/DEV/ELISP is a set of Emacs lisp functions that helps with developing with MLX-CL.
2. Usage
2.1. Loading
If you have not used Emacs before
It maybe a little difficult to switch from vim or VSCode. But the general idea is likely to be the same:
install Emacs
brew install jimeh/emacs-builds/emacs-app-good # or brew install d12frosted/emacs-plus/emacs-plus
load extension for lisp support
there're planty tutorials about it, but if you just want to try it quickly:
M-x list-packageswill show a list of avaliable packages- search for
slyand click to install it should done - and you may enjoy configuring your Emacs
- load the mlx-cl helping scripts
M-x load-fileand enter the path to themlx-cl.eland so on- or you can add
mlx-cl/dev/elispto your load-path
2.2. Tags
M-x load-file mlx-cl/dev/elisp/mlx-cl-tags.elmlx-cl-tag-mode: would toggle minor mode to highlight the tag in the code:;; TEST: #tag: would highlight#tagwhen clicking the
#tag, will jump to the test code named of#taglike(test tag ...)
2.3. GEN-DOC
M-x load-file mlx-cl/dev/elisp/mlx-cl-gen-doc.elM-x mlx-cl-gen-doc: would generate the documentation (export.orgfile asindex.html)Use
mlx-cl-before-gen-doc-hookandmlx-cl-after-gen-doc-hookto ensure Emacs is ready and clean up Emacs.For example, I use 11111000000/tao-theme-emacs and emacsorphanage/htmlize to generate the documentation, and here's my hook:
(add-hook 'mlx-cl-before-gen-doc-hook (lambda () (ryo.ui:mac-apply-theme 'dark))) (add-hook 'mlx-cl-after-gen-doc-hook (lambda () (ryo.ui:mac-apply-theme ns-system-appearance)))