docs/api: clean up; add results; add :eval header args
This commit is contained in:
parent
ea632fc530
commit
da25027dc3
1 changed files with 30 additions and 6 deletions
36
docs/api.org
36
docs/api.org
|
@ -5,7 +5,7 @@ This appendix serves as a reference on how to use Doom Emacs' standard library.
|
||||||
It is integrated into Helpful, in Doom.
|
It is integrated into Helpful, in Doom.
|
||||||
|
|
||||||
* Table of Contents :TOC_3:
|
* Table of Contents :TOC_3:
|
||||||
- [[#examples-for-dooms-core-library][Examples for Doom's core library]]
|
- [[#examples-for-dooms-library][Examples for Doom's library]]
|
||||||
- [[#core-lib][core-lib]]
|
- [[#core-lib][core-lib]]
|
||||||
- [[#add-hook][add-hook!]]
|
- [[#add-hook][add-hook!]]
|
||||||
- [[#add-transient-hook][add-transient-hook!]]
|
- [[#add-transient-hook][add-transient-hook!]]
|
||||||
|
@ -35,7 +35,7 @@ It is integrated into Helpful, in Doom.
|
||||||
- [[#persist-emacs-initial-frame-position-dimensions-andor-full-screen-state-across-sessions][Persist Emacs' initial frame position, dimensions and/or full-screen state across sessions]]
|
- [[#persist-emacs-initial-frame-position-dimensions-andor-full-screen-state-across-sessions][Persist Emacs' initial frame position, dimensions and/or full-screen state across sessions]]
|
||||||
- [[#update-cursor-shape-under-terminal-emacs][Update cursor shape under terminal Emacs]]
|
- [[#update-cursor-shape-under-terminal-emacs][Update cursor shape under terminal Emacs]]
|
||||||
|
|
||||||
* Examples for Doom's core library
|
* Examples for Doom's library
|
||||||
** core-lib
|
** core-lib
|
||||||
*** add-hook!
|
*** add-hook!
|
||||||
#+BEGIN_SRC elisp :eval no
|
#+BEGIN_SRC elisp :eval no
|
||||||
|
@ -99,6 +99,20 @@ It is integrated into Helpful, in Doom.
|
||||||
x)
|
x)
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
|
#+RESULTS:
|
||||||
|
: (a b c c d e)
|
||||||
|
|
||||||
|
#+BEGIN_SRC elisp
|
||||||
|
(let ((x '(a b c))
|
||||||
|
(y '(c d e))
|
||||||
|
(z '(f g)))
|
||||||
|
(appendq! x y z '(h))
|
||||||
|
x)
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
|
#+RESULTS:
|
||||||
|
: (a b c c d e f g h)
|
||||||
|
|
||||||
*** custom-set-faces!
|
*** custom-set-faces!
|
||||||
#+BEGIN_SRC elisp :eval no
|
#+BEGIN_SRC elisp :eval no
|
||||||
(custom-set-faces!
|
(custom-set-faces!
|
||||||
|
@ -223,7 +237,7 @@ It is integrated into Helpful, in Doom.
|
||||||
: /home/hlissner/.emacs.d/LICENSE
|
: /home/hlissner/.emacs.d/LICENSE
|
||||||
|
|
||||||
*** lambda!
|
*** lambda!
|
||||||
#+BEGIN_SRC elisp
|
#+BEGIN_SRC elisp :eval no
|
||||||
(map! "C-j" (lambda! (newline) (indent-according-to-mode)))
|
(map! "C-j" (lambda! (newline) (indent-according-to-mode)))
|
||||||
|
|
||||||
;; The `λ!' short-form alias exists. If you have the snippets module enabled and
|
;; The `λ!' short-form alias exists. If you have the snippets module enabled and
|
||||||
|
@ -236,19 +250,18 @@ When ~newline~ is passed a numerical prefix argument (=C-u 5 M-x newline=), it
|
||||||
inserts N newlines. We can use ~lambda!!~ to easily create a keybinds that bakes
|
inserts N newlines. We can use ~lambda!!~ to easily create a keybinds that bakes
|
||||||
in the prefix arg into the command call:
|
in the prefix arg into the command call:
|
||||||
|
|
||||||
#+BEGIN_SRC elisp
|
#+BEGIN_SRC elisp :eval no
|
||||||
(map! "C-j" (lambda!! #'newline 5))
|
(map! "C-j" (lambda!! #'newline 5))
|
||||||
|
|
||||||
;; The `λ!!' short-form alias exists. If you have the snippets module enabled
|
;; The `λ!!' short-form alias exists. If you have the snippets module enabled
|
||||||
;; and Doom's default snippets, a 'lam' snippet is available to expand into
|
;; and Doom's default snippets, a 'lam' snippet is available to expand into
|
||||||
;; 'λ!'. Otherwise, you can use `lambda!!'.
|
;; 'λ!'. Otherwise, you can use `lambda!!'.
|
||||||
(map! "C-j" (λ!! #'newline 5))
|
(map! "C-j" (λ!! #'newline 5))
|
||||||
|
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Or to create aliases for functions that behave differently:
|
Or to create aliases for functions that behave differently:
|
||||||
|
|
||||||
#+BEGIN_SRC elisp
|
#+BEGIN_SRC elisp :eval no
|
||||||
(fset 'insert-5-newlines (lambda!! #'newline 5))
|
(fset 'insert-5-newlines (lambda!! #'newline 5))
|
||||||
|
|
||||||
;; The equivalent of C-u M-x org-global-cycle, which resets the org document to
|
;; The equivalent of C-u M-x org-global-cycle, which resets the org document to
|
||||||
|
@ -402,6 +415,10 @@ These are side-by-side comparisons, showing how to bind keys with and without
|
||||||
(pushnew! list 'c 'd 'e)
|
(pushnew! list 'c 'd 'e)
|
||||||
list)
|
list)
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
|
#+RESULTS:
|
||||||
|
: (e d a b c)
|
||||||
|
|
||||||
*** prependq!
|
*** prependq!
|
||||||
#+BEGIN_SRC elisp
|
#+BEGIN_SRC elisp
|
||||||
(let ((x '(a b c)))
|
(let ((x '(a b c)))
|
||||||
|
@ -409,6 +426,9 @@ These are side-by-side comparisons, showing how to bind keys with and without
|
||||||
x)
|
x)
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
|
#+RESULTS:
|
||||||
|
: (c d e a b c)
|
||||||
|
|
||||||
#+BEGIN_SRC elisp
|
#+BEGIN_SRC elisp
|
||||||
(let ((x '(a b c))
|
(let ((x '(a b c))
|
||||||
(y '(c d e))
|
(y '(c d e))
|
||||||
|
@ -416,6 +436,10 @@ These are side-by-side comparisons, showing how to bind keys with and without
|
||||||
(prependq! x y z '(h))
|
(prependq! x y z '(h))
|
||||||
x)
|
x)
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
|
#+RESULTS:
|
||||||
|
: (c d e f g h a b c)
|
||||||
|
|
||||||
*** quiet!
|
*** quiet!
|
||||||
#+BEGIN_SRC elisp :eval no
|
#+BEGIN_SRC elisp :eval no
|
||||||
;; Enters recentf-mode without extra output
|
;; Enters recentf-mode without extra output
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue