emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
doomemacs/docs/examples.org

1015 lines
30 KiB
Org Mode
Raw Normal View History

docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:PROPERTIES:
:ID: e103c1bc-be8e-4451-8e43-a93d9e35e692
:END:
#+title: Examples
#+subtitle: Samples of Emacs/Doom dotfiles, concepts, and sub-projects
docs: use lowercase keywords As per Org's new defaults, which we're adopting elsewhere, so may as well adopt it here.
2022-03-28 15:03:21 +02:00
#+property: header-args:elisp :results pp
Add elisp demos for Doom API in helpful buffer
2019-07-21 14:53:19 +02:00
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
* Introduction
Examples speak louder than technical explanations, so this file exists to house
examples of Doom's (and Emacs') concepts, libraries, dotfiles, and more, for
your own reference. They are divided into Emacs-specific and Doom-specific
examples; where the former can also be useful to users who don't use Doom.
Some of Doom's components will read this file to generate documentation for you,
for example:
- Doom's [[doom-module:][:lang emacs-lisp]] module installs the [[doom-package:][elisp-demos]] package. This displays
usage examples alongside documentation in [[doom-package:][help]] and [[doom-package:][helpful]] buffers (produced
by =describe-*= and =helpful-*= commands; e.g. [[kbd:][<help> h f]]). Doom has extended
this package to search this file as well.
- [[id:1b8b8fa9-6233-4ed8-95c7-f46f8e4e2592][Some Doom's CLI commands]] will emit documentation informed by Doom's org files,
including this file.
If you're interested in adding to this document, read [[id:9ac0c15c-29e7-43f8-8926-5f0edb1098f0][the documentation section]]
of our contributing guide first.
* TODO Emacs
This section is dedicated to examples of concepts and libraries that can benefit
all Emacs users, whether or not they use Doom.
** TODO Emacs Lisp :demos:
**** file-name-with-extension
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 28.1
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
#+begin_src emacs-lisp
(file-name-with-extension "some/file.cpp" "h")
#+end_src
#+RESULTS:
: some/file.h
**** file-name-concat
:PROPERTIES:
:added: 28.1
:END:
#+begin_src emacs-lisp
(file-name-concat user-emacs-directory "lisp" "file.el")
#+end_src
#+begin_src emacs-lisp
(file-name-concat "foo" "bar" "baz")
#+end_src
#+RESULTS:
: foo/bar/baz
** TODO Templates
*** TODO Emacs package
*** TODO Dynamic module
* TODO Doom Emacs
This section is dedicated to examples of concepts and libraries only relevant to
Doom and its users. These are intended to be demonstrations, not substitutes for
documentation.
** TODO Emacs Lisp :demos:
*** doom-lib
**** add-hook!
:PROPERTIES:
:added: 3.0.0-pre
:END:
#+begin_src emacs-lisp
Add elisp demos for Doom API in helpful buffer
2019-07-21 14:53:19 +02:00
;; With only one hook and one function, this is identical to `add-hook'. In that
;; case, use that instead.
:boom: Refactor add-hook! macro & change arg order This update may potentially break your usage of add-hook! if you pass the :local or :append properties to it. This is how they used to work: (add-hook! :append 'some-mode-hook #'do-something) Thsoe properties must now follow the hooks, e.g. (add-hook! 'some-mode-hook :append #'do-something) Other changes: - Various add-hook calls have been renamed to add-hook! because I incorrectly assumed `defun` always returned its definition's symbol, when in fact, its return value is "undefined" (so sayeth the documentation). This should fix #1597. - This update adds the ability to add multiple functions to hooks without a list: (add-hook! 'some-mode-hook #'do-something #'do-something-else) - The indentation logic has been changed so that consecutive function symbols at indented at the same level as the first argument, but forms are indent like a defun. (add-hook! 'some-mode-hook #'do-something #'do-something-else) (add-hook! 'some-mode-hook (message "Hello"))
2019-07-26 19:57:13 +02:00
(add-hook! 'some-mode-hook #'enable-something)
Add elisp demos for Doom API in helpful buffer
2019-07-21 14:53:19 +02:00
;; Adding many-to-many functions to hooks
:boom: Refactor add-hook! macro & change arg order This update may potentially break your usage of add-hook! if you pass the :local or :append properties to it. This is how they used to work: (add-hook! :append 'some-mode-hook #'do-something) Thsoe properties must now follow the hooks, e.g. (add-hook! 'some-mode-hook :append #'do-something) Other changes: - Various add-hook calls have been renamed to add-hook! because I incorrectly assumed `defun` always returned its definition's symbol, when in fact, its return value is "undefined" (so sayeth the documentation). This should fix #1597. - This update adds the ability to add multiple functions to hooks without a list: (add-hook! 'some-mode-hook #'do-something #'do-something-else) - The indentation logic has been changed so that consecutive function symbols at indented at the same level as the first argument, but forms are indent like a defun. (add-hook! 'some-mode-hook #'do-something #'do-something-else) (add-hook! 'some-mode-hook (message "Hello"))
2019-07-26 19:57:13 +02:00
(add-hook! some-mode #'enable-something #'and-another)
docs(emacs-lisp): remove sharp-quoted example for add-hook! add-hook! is advertised to be able to add multiple hooks using a function-quoted list of functions, but add-hook! never actually supported this. Rather than correct the implementation, I'm correcting the documentation instead, because sharp-quoting lists betrays the semantics of the sharp-quote. Quoted lists should still work fine though (as documented in add-hook!'s docstring). Close: #5843
2022-04-03 14:48:22 +02:00
(add-hook! some-mode '(enable-something and-another))
:boom: Refactor add-hook! macro & change arg order This update may potentially break your usage of add-hook! if you pass the :local or :append properties to it. This is how they used to work: (add-hook! :append 'some-mode-hook #'do-something) Thsoe properties must now follow the hooks, e.g. (add-hook! 'some-mode-hook :append #'do-something) Other changes: - Various add-hook calls have been renamed to add-hook! because I incorrectly assumed `defun` always returned its definition's symbol, when in fact, its return value is "undefined" (so sayeth the documentation). This should fix #1597. - This update adds the ability to add multiple functions to hooks without a list: (add-hook! 'some-mode-hook #'do-something #'do-something-else) - The indentation logic has been changed so that consecutive function symbols at indented at the same level as the first argument, but forms are indent like a defun. (add-hook! 'some-mode-hook #'do-something #'do-something-else) (add-hook! 'some-mode-hook (message "Hello"))
2019-07-26 19:57:13 +02:00
(add-hook! '(one-mode-hook second-mode-hook) #'enable-something)
(add-hook! (one-mode second-mode) #'enable-something)
Add elisp demos for Doom API in helpful buffer
2019-07-21 14:53:19 +02:00
;; Appending and local hooks
:boom: Refactor add-hook! macro & change arg order This update may potentially break your usage of add-hook! if you pass the :local or :append properties to it. This is how they used to work: (add-hook! :append 'some-mode-hook #'do-something) Thsoe properties must now follow the hooks, e.g. (add-hook! 'some-mode-hook :append #'do-something) Other changes: - Various add-hook calls have been renamed to add-hook! because I incorrectly assumed `defun` always returned its definition's symbol, when in fact, its return value is "undefined" (so sayeth the documentation). This should fix #1597. - This update adds the ability to add multiple functions to hooks without a list: (add-hook! 'some-mode-hook #'do-something #'do-something-else) - The indentation logic has been changed so that consecutive function symbols at indented at the same level as the first argument, but forms are indent like a defun. (add-hook! 'some-mode-hook #'do-something #'do-something-else) (add-hook! 'some-mode-hook (message "Hello"))
2019-07-26 19:57:13 +02:00
(add-hook! (one-mode second-mode) :append #'enable-something)
(add-hook! (one-mode second-mode) :local #'enable-something)
Add elisp demos for Doom API in helpful buffer
2019-07-21 14:53:19 +02:00
;; With arbitrary forms
(add-hook! (one-mode second-mode) (setq v 5) (setq a 2))
:boom: Refactor add-hook! macro & change arg order This update may potentially break your usage of add-hook! if you pass the :local or :append properties to it. This is how they used to work: (add-hook! :append 'some-mode-hook #'do-something) Thsoe properties must now follow the hooks, e.g. (add-hook! 'some-mode-hook :append #'do-something) Other changes: - Various add-hook calls have been renamed to add-hook! because I incorrectly assumed `defun` always returned its definition's symbol, when in fact, its return value is "undefined" (so sayeth the documentation). This should fix #1597. - This update adds the ability to add multiple functions to hooks without a list: (add-hook! 'some-mode-hook #'do-something #'do-something-else) - The indentation logic has been changed so that consecutive function symbols at indented at the same level as the first argument, but forms are indent like a defun. (add-hook! 'some-mode-hook #'do-something #'do-something-else) (add-hook! 'some-mode-hook (message "Hello"))
2019-07-26 19:57:13 +02:00
(add-hook! (one-mode second-mode) :append :local (setq v 5) (setq a 2))
Add elisp demos for Doom API in helpful buffer
2019-07-21 14:53:19 +02:00
;; Inline named hook functions
(add-hook! '(one-mode-hook second-mode-hook)
(defun do-something ()
...)
(defun do-another-thing ()
...))
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
Add elisp demos for Doom API in helpful buffer
2019-07-21 14:53:19 +02:00
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** TODO add-transient-hook!
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 3.0.0-pre
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** after!
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 3.0.0-pre
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp :eval no
Add after! example to docs/api.org
2019-09-09 19:21:17 -04:00
;;; `after!' will take:
;; An unquoted package symbol (the name of a package)
(after! helm ...)
;; An unquoted list of package symbols (i.e. BODY is evaluated once both magit
;; and git-gutter have loaded)
(after! (magit git-gutter) ...)
;; An unquoted, nested list of compound package lists, using any combination of
;; :or/:any and :and/:all
(after! (:or package-a package-b ...) ...)
(after! (:and package-a package-b ...) ...)
(after! (:and package-a (:or package-b package-c) ...) ...)
;; (Without :or/:any/:and/:all, :and/:all are implied.)
;; A common mistake is to pass it the names of major or minor modes, e.g.
(after! rustic-mode ...)
(after! python-mode ...)
;; But the code in them will never run! rustic-mode is in the `rustic' package
;; and python-mode is in the `python' package. This is what you want:
(after! rustic ...)
(after! python ...)
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** appendq!
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 3.0.0-pre
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp
docs/api: add appendq!, prependq! & pushnew! demos
2019-12-15 04:49:51 -05:00
(let ((x '(a b c)))
(appendq! x '(c d e))
x)
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
Add after! example to docs/api.org
2019-09-09 19:21:17 -04:00
docs/api: clean up; add results; add :eval header args
2019-12-15 22:54:24 -05:00
#+RESULTS:
: (a b c c d e)
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp
docs/api: clean up; add results; add :eval header args
2019-12-15 22:54:24 -05:00
(let ((x '(a b c))
(y '(c d e))
(z '(f g)))
(appendq! x y z '(h))
x)
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
docs/api: clean up; add results; add :eval header args
2019-12-15 22:54:24 -05:00
#+RESULTS:
: (a b c c d e f g h)
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** custom-set-faces!
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 3.0.0-pre
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp :eval no
Reformat docs/api.org
2019-09-07 19:56:52 -04:00
(custom-set-faces!
docs/api: fix quoting for custom-(theme-)?set-faces!
2019-08-18 14:38:45 -04:00
'(outline-1 :weight normal)
'(outline-2 :weight normal)
'(outline-3 :weight normal)
'(outline-4 :weight normal)
'(outline-5 :weight normal)
'(outline-6 :weight normal)
'(default :background "red" :weight bold)
'(region :background "red" :weight bold))
docs/api: add custom{,-theme}-set-faces! entry
2019-07-25 12:25:23 +02:00
Reformat docs/api.org
2019-09-07 19:56:52 -04:00
(custom-set-faces!
docs/api: fix quoting for custom-(theme-)?set-faces!
2019-08-18 14:38:45 -04:00
'((outline-1 outline-2 outline-3 outline-4 outline-5 outline-6)
docs/api: add custom{,-theme}-set-faces! entry
2019-07-25 12:25:23 +02:00
:weight normal)
docs/api: fix quoting for custom-(theme-)?set-faces!
2019-08-18 14:38:45 -04:00
'((default region)
docs/api: add custom{,-theme}-set-faces! entry
2019-07-25 12:25:23 +02:00
:background "red" :weight bold))
(let ((red-bg-faces '(default region)))
Reformat docs/api.org
2019-09-07 19:56:52 -04:00
(custom-set-faces!
docs/api: add custom{,-theme}-set-faces! entry
2019-07-25 12:25:23 +02:00
`(,(cl-loop for i from 0 to 6 collect (intern (format "outline-%d" i)))
:weight normal)
`(,red-bg-faces
:background "red" :weight bold)))
Expand custom{-theme,}-set-faces! example in docs/api.org To include usage of doom-themes' api
2019-09-09 21:55:27 -04:00
lang/emacs-lisp: fix custom-{,theme-}set-faces! demos No need to load the theme before using its API. The rules are deferred in any case.
2021-02-18 11:53:10 -05:00
;; You may utilise `doom-themes's theme API to fetch or tweak colors from their
;; palettes. No need to wait until the theme or package is loaded. e.g.
Expand custom{-theme,}-set-faces! example in docs/api.org To include usage of doom-themes' api
2019-09-09 21:55:27 -04:00
(custom-set-faces!
`(outline-1 :foreground ,(doom-color 'red))
`(outline-2 :background ,(doom-color 'blue)))
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
docs/api: add custom{,-theme}-set-faces! entry
2019-07-25 12:25:23 +02:00
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** custom-theme-set-faces!
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 3.0.0-pre
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp :eval no
docs/api: correct custom-theme-set-faces! example
2020-08-25 05:12:54 -04:00
(custom-theme-set-faces! 'doom-one
docs/api: fix quoting for custom-(theme-)?set-faces!
2019-08-18 14:38:45 -04:00
'(outline-1 :weight normal)
'(outline-2 :weight normal)
'(outline-3 :weight normal)
'(outline-4 :weight normal)
'(outline-5 :weight normal)
'(outline-6 :weight normal)
'(default :background "red" :weight bold)
'(region :background "red" :weight bold))
docs/api: add custom{,-theme}-set-faces! entry
2019-07-25 12:25:23 +02:00
Reformat docs/api.org
2019-09-07 19:56:52 -04:00
(custom-theme-set-faces! '(doom-one-theme doom-one-light-theme)
docs/api: fix quoting for custom-(theme-)?set-faces!
2019-08-18 14:38:45 -04:00
'((outline-1 outline-2 outline-3 outline-4 outline-5 outline-6)
docs/api: add custom{,-theme}-set-faces! entry
2019-07-25 12:25:23 +02:00
:weight normal)
docs/api: fix quoting for custom-(theme-)?set-faces!
2019-08-18 14:38:45 -04:00
'((default region)
docs/api: add custom{,-theme}-set-faces! entry
2019-07-25 12:25:23 +02:00
:background "red" :weight bold))
(let ((red-bg-faces '(default region)))
Reformat docs/api.org
2019-09-07 19:56:52 -04:00
(custom-theme-set-faces! '(doom-one-theme doom-one-light-theme)
docs/api: add custom{,-theme}-set-faces! entry
2019-07-25 12:25:23 +02:00
`(,(cl-loop for i from 0 to 6 collect (intern (format "outline-%d" i)))
:weight normal)
`(,red-bg-faces
:background "red" :weight bold)))
Expand custom{-theme,}-set-faces! example in docs/api.org To include usage of doom-themes' api
2019-09-09 21:55:27 -04:00
lang/emacs-lisp: fix custom-{,theme-}set-faces! demos No need to load the theme before using its API. The rules are deferred in any case.
2021-02-18 11:53:10 -05:00
;; You may utilise `doom-themes's theme API to fetch or tweak colors from their
;; palettes. No need to wait until the theme or package is loaded. e.g.
Expand custom{-theme,}-set-faces! example in docs/api.org To include usage of doom-themes' api
2019-09-09 21:55:27 -04:00
(custom-theme-set-faces! 'doom-one
`(outline-1 :foreground ,(doom-color 'red))
`(outline-2 :background ,(doom-color 'blue)))
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
docs/api: add custom{,-theme}-set-faces! entry
2019-07-25 12:25:23 +02:00
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** TODO defer-feature!
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 3.0.0-pre
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** TODO defer-until!
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 3.0.0-pre
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** disable-packages!
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 3.0.0-pre
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp :eval no
Add more api demos (#1845) * Added function Demos * Added use-package demos * Some corrections * Fix duplicated use-package! type
2019-10-03 14:51:08 -04:00
;; Disable packages enabled by DOOM
(disable-packages! some-package second-package)
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
Add more api demos (#1845) * Added function Demos * Added use-package demos * Some corrections * Fix duplicated use-package! type
2019-10-03 14:51:08 -04:00
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** file-exists-p!
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 3.0.0-pre
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp
Refactor file-exists-p macro And refactor too doom--resolve-path-forms
2019-07-23 20:32:40 +02:00
(file-exists-p! "init.el" doom-emacs-dir)
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
Refactor file-exists-p macro And refactor too doom--resolve-path-forms
2019-07-23 20:32:40 +02:00
#+RESULTS:
: /home/hlissner/.emacs.d/init.el
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp
Refactor file-exists-p macro And refactor too doom--resolve-path-forms
2019-07-23 20:32:40 +02:00
(file-exists-p! (and (or "doesnotexist" "init.el")
"LICENSE")
doom-emacs-dir)
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
Refactor file-exists-p macro And refactor too doom--resolve-path-forms
2019-07-23 20:32:40 +02:00
#+RESULTS:
: /home/hlissner/.emacs.d/LICENSE
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** cmd!
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 3.0.0-pre
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp :eval no
Add cmd!, cmd!!, cmds! convenience macros It's kind of silly that our command lambda macros (λ! and λ!!) need a snippet, special key sequence or copy-paste to insert, so in the spirit of fn! -- and to make sure they take up less space than `lambda!` -- I've added `cmd!` and `cmd!!` aliases. `lambda!` and `lambda!!` are now deprecated. λ! and λ!! will remain. I've also added `cmds!` as a convenience wrapper around general-predicate-dispatch.
2020-05-27 16:12:45 -04:00
(map! "C-j" (cmd! (newline) (indent-according-to-mode)))
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
Add cmd!, cmd!!, cmds! convenience macros It's kind of silly that our command lambda macros (λ! and λ!!) need a snippet, special key sequence or copy-paste to insert, so in the spirit of fn! -- and to make sure they take up less space than `lambda!` -- I've added `cmd!` and `cmd!!` aliases. `lambda!` and `lambda!!` are now deprecated. λ! and λ!! will remain. I've also added `cmds!` as a convenience wrapper around general-predicate-dispatch.
2020-05-27 16:12:45 -04:00
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** cmd!!
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 3.0.0-pre
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
docs/api: add lambda!! demos
2019-12-13 14:30:42 -05:00
When ~newline~ is passed a numerical prefix argument (=C-u 5 M-x newline=), it
Add cmd!, cmd!!, cmds! convenience macros It's kind of silly that our command lambda macros (λ! and λ!!) need a snippet, special key sequence or copy-paste to insert, so in the spirit of fn! -- and to make sure they take up less space than `lambda!` -- I've added `cmd!` and `cmd!!` aliases. `lambda!` and `lambda!!` are now deprecated. λ! and λ!! will remain. I've also added `cmds!` as a convenience wrapper around general-predicate-dispatch.
2020-05-27 16:12:45 -04:00
inserts N newlines. We can use ~cmd!!~ to easily create a keybinds that bakes in
the prefix arg into the command call:
docs/api: add lambda!! demos
2019-12-13 14:30:42 -05:00
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp :eval no
Add cmd!, cmd!!, cmds! convenience macros It's kind of silly that our command lambda macros (λ! and λ!!) need a snippet, special key sequence or copy-paste to insert, so in the spirit of fn! -- and to make sure they take up less space than `lambda!` -- I've added `cmd!` and `cmd!!` aliases. `lambda!` and `lambda!!` are now deprecated. λ! and λ!! will remain. I've also added `cmds!` as a convenience wrapper around general-predicate-dispatch.
2020-05-27 16:12:45 -04:00
(map! "C-j" (cmd!! #'newline 5))
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
docs/api: add lambda!! demos
2019-12-13 14:30:42 -05:00
Or to create aliases for functions that behave differently:
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp :eval no
Add cmd!, cmd!!, cmds! convenience macros It's kind of silly that our command lambda macros (λ! and λ!!) need a snippet, special key sequence or copy-paste to insert, so in the spirit of fn! -- and to make sure they take up less space than `lambda!` -- I've added `cmd!` and `cmd!!` aliases. `lambda!` and `lambda!!` are now deprecated. λ! and λ!! will remain. I've also added `cmds!` as a convenience wrapper around general-predicate-dispatch.
2020-05-27 16:12:45 -04:00
(fset 'insert-5-newlines (cmd!! #'newline 5))
docs/api: add lambda!! demos
2019-12-13 14:30:42 -05:00
;; The equivalent of C-u M-x org-global-cycle, which resets the org document to
;; its startup visibility settings.
Add cmd!, cmd!!, cmds! convenience macros It's kind of silly that our command lambda macros (λ! and λ!!) need a snippet, special key sequence or copy-paste to insert, so in the spirit of fn! -- and to make sure they take up less space than `lambda!` -- I've added `cmd!` and `cmd!!` aliases. `lambda!` and `lambda!!` are now deprecated. λ! and λ!! will remain. I've also added `cmds!` as a convenience wrapper around general-predicate-dispatch.
2020-05-27 16:12:45 -04:00
(fset 'org-reset-global-visibility (cmd!! #'org-global-cycle '(4))
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
Add cmd!, cmd!!, cmds! convenience macros It's kind of silly that our command lambda macros (λ! and λ!!) need a snippet, special key sequence or copy-paste to insert, so in the spirit of fn! -- and to make sure they take up less space than `lambda!` -- I've added `cmd!` and `cmd!!` aliases. `lambda!` and `lambda!!` are now deprecated. λ! and λ!! will remain. I've also added `cmds!` as a convenience wrapper around general-predicate-dispatch.
2020-05-27 16:12:45 -04:00
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** cmds!
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 3.0.0-pre
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp :eval no
refactor: deprecate featurep! for modulep! featurep! will be renamed modulep! in the future, so it's been deprecated. They have identical interfaces, and can be replaced without issue. featurep! was never quite the right name for this macro. It implied that it had some connection to featurep, which it doesn't (only that it was similar in purpose; still, Doom modules are not features). To undo such implications and be consistent with its namespace (and since we're heading into a storm of breaking changes with the v3 release anyway), now was the best opportunity to begin the transition.
2022-08-12 20:29:19 +02:00
(map! :i [tab] (cmds! (and (modulep! :editor snippets)
docs/api: add cmds! & kbd! demos
2020-12-11 17:50:04 -05:00
(bound-and-true-p yas-minor-mode)
(yas-maybe-expand-abbrev-key-filter 'yas-expand))
#'yas-expand
refactor: deprecate featurep! for modulep! featurep! will be renamed modulep! in the future, so it's been deprecated. They have identical interfaces, and can be replaced without issue. featurep! was never quite the right name for this macro. It implied that it had some connection to featurep, which it doesn't (only that it was similar in purpose; still, Doom modules are not features). To undo such implications and be consistent with its namespace (and since we're heading into a storm of breaking changes with the v3 release anyway), now was the best opportunity to begin the transition.
2022-08-12 20:29:19 +02:00
(modulep! :completion company +tng)
docs/api: add cmds! & kbd! demos
2020-12-11 17:50:04 -05:00
#'company-indent-or-complete-common)
:m [tab] (cmds! (and (bound-and-true-p yas-minor-mode)
(evil-visual-state-p)
(or (eq evil-visual-selection 'line)
(not (memq (char-after) (list ?\( ?\[ ?\{ ?\} ?\] ?\))))))
#'yas-insert-snippet
refactor: deprecate featurep! for modulep! featurep! will be renamed modulep! in the future, so it's been deprecated. They have identical interfaces, and can be replaced without issue. featurep! was never quite the right name for this macro. It implied that it had some connection to featurep, which it doesn't (only that it was similar in purpose; still, Doom modules are not features). To undo such implications and be consistent with its namespace (and since we're heading into a storm of breaking changes with the v3 release anyway), now was the best opportunity to begin the transition.
2022-08-12 20:29:19 +02:00
(and (modulep! :editor fold)
docs/api: add cmds! & kbd! demos
2020-12-11 17:50:04 -05:00
(save-excursion (end-of-line) (invisible-p (point))))
#'+fold/toggle
(fboundp 'evil-jump-item)
#'evil-jump-item))
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
docs/api: add cmds! & kbd! demos
2020-12-11 17:50:04 -05:00
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** kbd!
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 3.0.0-pre
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp :eval no
docs/api: add cmds! & kbd! demos
2020-12-11 17:50:04 -05:00
(map! "," (kbd! "SPC")
";" (kbd! ":"))
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
docs/api: add cmds! & kbd! demos
2020-12-11 17:50:04 -05:00
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** lambda!
docs(emacs-lisp): add fn! & lambda! demos
2022-06-21 21:27:00 +02:00
#+begin_src emacs-lisp
(mapcar (lambda! ((&key foo bar baz))
(list foo bar baz))
'((:foo 10 :bar 25)
(:baz hello :boop nil)
(:bar 42)))
#+end_src
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** fn!
docs(emacs-lisp): add fn! & lambda! demos
2022-06-21 21:27:00 +02:00
#+begin_src emacs-lisp
(mapcar (fn! (symbol-name %)) '(hello world))
#+end_src
#+begin_src emacs-lisp
(seq-sort (fn! (string-lessp (symbol-name %1)
(symbol-name %2)))
'(bonzo foo bar buddy doomguy baz zombies))
#+end_src
#+begin_src emacs-lisp
(format "You passed %d arguments to this function"
(funcall (fn! (length %*)) :foo :bar :baz "hello" 123 t))
#+end_src
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** load!
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 3.0.0-pre
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp :eval no
Add load! example to docs/api.org
2019-09-09 19:13:51 -04:00
;;; Lets say we're in ~/.doom.d/config.el
(load! "lisp/module") ; loads ~/.doom.d/lisp/module.el
(load! "somefile" doom-emacs-dir) ; loads ~/.emacs.d/somefile.el
refactor: deprecate doom-private-dir for doom-user-dir - Deprecates the doom-private-dir variable in favor of doom-user-dir. - Renames the pseudo category for the user's module: :private -> :user. - Renames the doom-private-error error type to doom-user-error. Emacs uses the term "user" to refer to the "things" in user space (e.g. user-init-file, user-emacs-directory, user-mail-address, xdg-user-dirs, package-user-dir, etc), and I'd like to be consistent with that. It also has the nice side-effect of being slightly shorter. I also hope 'doom-user-error' will be less obtuse to beginners than 'doom-private-error'.
2022-08-13 21:27:11 +02:00
(load! "anotherfile" doom-user-dir) ; loads ~/.doom.d/anotherfile.el
Add load! example to docs/api.org
2019-09-09 19:13:51 -04:00
;; If you don't want a `load!' call to throw an error if the file doesn't exist:
(load! "~/.maynotexist" nil t)
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
Add load! example to docs/api.org
2019-09-09 19:13:51 -04:00
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** map!
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 3.0.0-pre
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp :eval no
Add more api demos (#1845) * Added function Demos * Added use-package demos * Some corrections * Fix duplicated use-package! type
2019-10-03 14:51:08 -04:00
(map! :map magit-mode-map
:m "C-r" 'do-something ; C-r in motion state
:nv "q" 'magit-mode-quit-window ; q in normal+visual states
"C-x C-r" 'a-global-keybind
:g "C-x C-r" 'another-global-keybind ; same as above
(:when IS-MAC
:n "M-s" 'some-fn
docs/api: fix inline command in map! example
2020-07-28 15:50:25 -04:00
:i "M-o" (cmd! (message "Hi"))))
Add more api demos (#1845) * Added function Demos * Added use-package demos * Some corrections * Fix duplicated use-package! type
2019-10-03 14:51:08 -04:00
refactor: deprecate featurep! for modulep! featurep! will be renamed modulep! in the future, so it's been deprecated. They have identical interfaces, and can be replaced without issue. featurep! was never quite the right name for this macro. It implied that it had some connection to featurep, which it doesn't (only that it was similar in purpose; still, Doom modules are not features). To undo such implications and be consistent with its namespace (and since we're heading into a storm of breaking changes with the v3 release anyway), now was the best opportunity to begin the transition.
2022-08-12 20:29:19 +02:00
(map! (:when (modulep! :completion company) ; Conditional loading
Add more api demos (#1845) * Added function Demos * Added use-package demos * Some corrections * Fix duplicated use-package! type
2019-10-03 14:51:08 -04:00
:i "C-@" #'+company/complete
(:prefix "C-x" ; Use a prefix key
:i "C-l" #'+company/whole-lines)))
refactor: deprecate featurep! for modulep! featurep! will be renamed modulep! in the future, so it's been deprecated. They have identical interfaces, and can be replaced without issue. featurep! was never quite the right name for this macro. It implied that it had some connection to featurep, which it doesn't (only that it was similar in purpose; still, Doom modules are not features). To undo such implications and be consistent with its namespace (and since we're heading into a storm of breaking changes with the v3 release anyway), now was the best opportunity to begin the transition.
2022-08-12 20:29:19 +02:00
(map! (:when (modulep! :lang latex) ; local conditional
Add more api demos (#1845) * Added function Demos * Added use-package demos * Some corrections * Fix duplicated use-package! type
2019-10-03 14:51:08 -04:00
(:map LaTeX-mode-map
:localleader ; Use local leader
:desc "View" "v" #'TeX-view)) ; Add which-key description
:leader ; Use leader key from now on
:desc "Eval expression" ";" #'eval-expression)
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
Add more api demos (#1845) * Added function Demos * Added use-package demos * Some corrections * Fix duplicated use-package! type
2019-10-03 14:51:08 -04:00
docs/api: expand map! example
2019-11-14 15:43:44 -05:00
These are side-by-side comparisons, showing how to bind keys with and without
~map!~:
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp :eval no
docs/api: expand map! example
2019-11-14 15:43:44 -05:00
;; bind a global key
(global-set-key (kbd "C-x y") #'do-something)
(map! "C-x y" #'do-something)
;; bind a key on a keymap
docs/api: fix keymap in map! examples
2020-08-06 14:22:41 -04:00
(define-key emacs-lisp-mode-map (kbd "C-c p") #'do-something)
(map! :map emacs-lisp-mode-map "C-c p" #'do-something)
docs/api: expand map! example
2019-11-14 15:43:44 -05:00
;; unbind a key defined elsewhere
(define-key lua-mode-map (kbd "SPC m b") nil)
(map! :map lua-mode-map "SPC m b" nil)
;; bind multiple keys
docs/api: correct global-set-key uses
2019-11-25 15:28:38 -05:00
(global-set-key (kbd "C-x x") #'do-something)
(global-set-key (kbd "C-x y") #'do-something-else)
(global-set-key (kbd "C-x z") #'do-another-thing)
docs/api: expand map! example
2019-11-14 15:43:44 -05:00
(map! "C-x x" #'do-something
"C-x y" #'do-something-else
"C-x z" #'do-another-thing)
;; bind global keys in normal mode
(evil-define-key* 'normal 'global
(kbd "C-x x") #'do-something
(kbd "C-x y") #'do-something-else
(kbd "C-x z") #'do-another-thing)
(map! :n "C-x x" #'do-something
:n "C-x y" #'do-something-else
:n "C-x z" #'do-another-thing)
;; or on a deferred keymap
(evil-define-key 'normal emacs-lisp-mode-map
(kbd "C-x x") #'do-something
(kbd "C-x y") #'do-something-else
(kbd "C-x z") #'do-another-thing)
(map! :map emacs-lisp-mode-map
:n "C-x x" #'do-something
:n "C-x y" #'do-something-else
:n "C-x z" #'do-another-thing)
;; or multiple maps
(dolist (map (list emacs-lisp-mode go-mode-map ivy-minibuffer-map))
(evil-define-key '(normal insert) map
"a" #'a
"b" #'b
"c" #'c))
(map! :map (emacs-lisp-mode go-mode-map ivy-minibuffer-map)
:ni "a" #'a
:ni "b" #'b
:ni "c" #'c)
;; or in multiple states (order of states doesn't matter)
(evil-define-key* '(normal visual) emacs-lisp-mode-map (kbd "C-x x") #'do-something)
(evil-define-key* 'insert emacs-lisp-mode-map (kbd "C-x x") #'do-something-else)
(evil-define-key* '(visual normal insert emacs) emacs-lisp-mode-map (kbd "C-x z") #'do-another-thing)
(map! :map emacs-lisp-mode
:nv "C-x x" #'do-something ; normal+visual
:i "C-x y" #'do-something-else ; insert
:vnie "C-x z" #'do-another-thing) ; visual+normal+insert+emacs
;; You can nest map! calls:
(evil-define-key* '(normal visual) emacs-lisp-mode-map (kbd "C-x x") #'do-something)
(evil-define-key* 'normal go-lisp-mode-map (kbd "C-x x") #'do-something-else)
(map! (:map emacs-lisp-mode :nv "C-x x" #'do-something)
(:map go-lisp-mode :n "C-x x" #'do-something-else))
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
docs/api: expand map! example
2019-11-14 15:43:44 -05:00
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** pushnew!
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 3.0.0-pre
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp
docs/api: add appendq!, prependq! & pushnew! demos
2019-12-15 04:49:51 -05:00
(let ((list '(a b c)))
(pushnew! list 'c 'd 'e)
list)
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
docs/api: clean up; add results; add :eval header args
2019-12-15 22:54:24 -05:00
#+RESULTS:
: (e d a b c)
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** prependq!
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 3.0.0-pre
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp
docs/api: add appendq!, prependq! & pushnew! demos
2019-12-15 04:49:51 -05:00
(let ((x '(a b c)))
(prependq! x '(c d e))
x)
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
docs/api: add appendq!, prependq! & pushnew! demos
2019-12-15 04:49:51 -05:00
docs/api: clean up; add results; add :eval header args
2019-12-15 22:54:24 -05:00
#+RESULTS:
: (c d e a b c)
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp
docs/api: add appendq!, prependq! & pushnew! demos
2019-12-15 04:49:51 -05:00
(let ((x '(a b c))
(y '(c d e))
(z '(f g)))
(prependq! x y z '(h))
x)
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
docs/api: clean up; add results; add :eval header args
2019-12-15 22:54:24 -05:00
#+RESULTS:
: (c d e f g h a b c)
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** quiet!
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 3.0.0-pre
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp :eval no
Add more api demos (#1845) * Added function Demos * Added use-package demos * Some corrections * Fix duplicated use-package! type
2019-10-03 14:51:08 -04:00
;; Enters recentf-mode without extra output
(quiet! (recentf-mode +1))
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** remove-hook!
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 3.0.0-pre
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp :eval no
docs/api: minor comment corrections
2019-07-29 18:56:49 +02:00
;; With only one hook and one function, this is identical to `remove-hook'. In
;; that case, use that instead.
:boom: Refactor add-hook! macro & change arg order This update may potentially break your usage of add-hook! if you pass the :local or :append properties to it. This is how they used to work: (add-hook! :append 'some-mode-hook #'do-something) Thsoe properties must now follow the hooks, e.g. (add-hook! 'some-mode-hook :append #'do-something) Other changes: - Various add-hook calls have been renamed to add-hook! because I incorrectly assumed `defun` always returned its definition's symbol, when in fact, its return value is "undefined" (so sayeth the documentation). This should fix #1597. - This update adds the ability to add multiple functions to hooks without a list: (add-hook! 'some-mode-hook #'do-something #'do-something-else) - The indentation logic has been changed so that consecutive function symbols at indented at the same level as the first argument, but forms are indent like a defun. (add-hook! 'some-mode-hook #'do-something #'do-something-else) (add-hook! 'some-mode-hook (message "Hello"))
2019-07-26 19:57:13 +02:00
(remove-hook! 'some-mode-hook #'enable-something)
Add elisp demos for Doom API in helpful buffer
2019-07-21 14:53:19 +02:00
docs/api: minor comment corrections
2019-07-29 18:56:49 +02:00
;; Removing N functions from M hooks
:boom: Refactor add-hook! macro & change arg order This update may potentially break your usage of add-hook! if you pass the :local or :append properties to it. This is how they used to work: (add-hook! :append 'some-mode-hook #'do-something) Thsoe properties must now follow the hooks, e.g. (add-hook! 'some-mode-hook :append #'do-something) Other changes: - Various add-hook calls have been renamed to add-hook! because I incorrectly assumed `defun` always returned its definition's symbol, when in fact, its return value is "undefined" (so sayeth the documentation). This should fix #1597. - This update adds the ability to add multiple functions to hooks without a list: (add-hook! 'some-mode-hook #'do-something #'do-something-else) - The indentation logic has been changed so that consecutive function symbols at indented at the same level as the first argument, but forms are indent like a defun. (add-hook! 'some-mode-hook #'do-something #'do-something-else) (add-hook! 'some-mode-hook (message "Hello"))
2019-07-26 19:57:13 +02:00
(remove-hook! some-mode #'enable-something #'and-another)
(remove-hook! some-mode #'(enable-something and-another))
(remove-hook! '(one-mode-hook second-mode-hook) #'enable-something)
(remove-hook! (one-mode second-mode) #'enable-something)
Add elisp demos for Doom API in helpful buffer
2019-07-21 14:53:19 +02:00
docs/api: minor comment corrections
2019-07-29 18:56:49 +02:00
;; Removing buffer-local hooks
:boom: Refactor add-hook! macro & change arg order This update may potentially break your usage of add-hook! if you pass the :local or :append properties to it. This is how they used to work: (add-hook! :append 'some-mode-hook #'do-something) Thsoe properties must now follow the hooks, e.g. (add-hook! 'some-mode-hook :append #'do-something) Other changes: - Various add-hook calls have been renamed to add-hook! because I incorrectly assumed `defun` always returned its definition's symbol, when in fact, its return value is "undefined" (so sayeth the documentation). This should fix #1597. - This update adds the ability to add multiple functions to hooks without a list: (add-hook! 'some-mode-hook #'do-something #'do-something-else) - The indentation logic has been changed so that consecutive function symbols at indented at the same level as the first argument, but forms are indent like a defun. (add-hook! 'some-mode-hook #'do-something #'do-something-else) (add-hook! 'some-mode-hook (message "Hello"))
2019-07-26 19:57:13 +02:00
(remove-hook! (one-mode second-mode) :local #'enable-something)
Add elisp demos for Doom API in helpful buffer
2019-07-21 14:53:19 +02:00
docs/api: minor comment corrections
2019-07-29 18:56:49 +02:00
;; Removing arbitrary forms (must be exactly the same as the definition)
Add elisp demos for Doom API in helpful buffer
2019-07-21 14:53:19 +02:00
(remove-hook! (one-mode second-mode) (setq v 5) (setq a 2))
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** setq!
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 3.0.0-pre
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp
docs/api: add setq! demo
2020-01-24 17:50:45 -05:00
;; Each of these have a setter associated with them, which must be triggered in
;; order for their new values to have an effect.
(setq! evil-want-Y-yank-to-eol nil
evil-want-C-u-scroll nil
evil-want-C-d-scroll nil)
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** setq-hook!
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 3.0.0-pre
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp :eval no
Add more api demos (#1845) * Added function Demos * Added use-package demos * Some corrections * Fix duplicated use-package! type
2019-10-03 14:51:08 -04:00
;; Set multiple variables after a hook
(setq-hook! 'markdown-mode-hook
line-spacing 2
fill-column 80)
;; Set variables after multiple hooks
(setq-hook! '(eshell-mode-hook term-mode-hook)
hscroll-margin 0)
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
Add more api demos (#1845) * Added function Demos * Added use-package demos * Some corrections * Fix duplicated use-package! type
2019-10-03 14:51:08 -04:00
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** unsetq-hook!
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 3.0.0-pre
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp :eval no
Add more api demos (#1845) * Added function Demos * Added use-package demos * Some corrections * Fix duplicated use-package! type
2019-10-03 14:51:08 -04:00
(unsetq-hook! 'markdown-mode-hook line-spacing)
;; Removes the following variable hook
(setq-hook! 'markdown-mode-hook line-spacing 2)
Reformat docs/api.org
2019-09-07 19:56:52 -04:00
Add more api demos (#1845) * Added function Demos * Added use-package demos * Some corrections * Fix duplicated use-package! type
2019-10-03 14:51:08 -04:00
;; Removing N variables from M hooks
(unsetq-hook! some-mode enable-something and-another)
(unsetq-hook! some-mode (enable-something and-another))
(unsetq-hook! '(one-mode-hook second-mode-hook) enable-something)
(unsetq-hook! (one-mode second-mode) enable-something)
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** versionp!
:PROPERTIES:
:added: 3.0.0-pre
:END:
#+begin_src emacs-lisp
(versionp! "25.3" > "27.1")
#+end_src
#+RESULTS:
: nil
#+begin_src emacs-lisp
(versionp! "28.0" <= emacs-version <= "28.1")
#+end_src
#+RESULTS:
: t
Add more api demos (#1845) * Added function Demos * Added use-package demos * Some corrections * Fix duplicated use-package! type
2019-10-03 14:51:08 -04:00
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
*** doom-modules
**** doom!
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:PROPERTIES:
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
:added: 3.0.0-pre
:END:
#+begin_src emacs-lisp :eval no
(doom! :completion
company
ivy
;;helm
:tools
(:if IS-MAC macos)
docker
lsp
:lang
(cc +lsp)
(:cond ((string= system-name "work-pc")
python
rust
web)
((string= system-name "writing-pc")
(org +dragndrop)
ruby))
(:if IS-LINUX
(web +lsp)
web)
:config
literate
(default +bindings +smartparens))
#+end_src
**** use-package!
:PROPERTIES:
:added: 3.0.0-pre
docs(emacs-lisp): insert :added: properties in demos To help identify when they (and future functions/macros) were added.
2022-06-17 14:43:36 +02:00
:END:
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+begin_src emacs-lisp :eval no
Add more api demos (#1845) * Added function Demos * Added use-package demos * Some corrections * Fix duplicated use-package! type
2019-10-03 14:51:08 -04:00
;; Use after-call to load package before hook
(use-package! projectile
:after-call (pre-command-hook after-find-file dired-before-readin-hook))
;; defer recentf packages one by one
(use-package! recentf
:defer-incrementally easymenu tree-widget timer
:after-call after-find-file)
;; This is equivalent to :defer-incrementally (abc)
(use-package! abc
:defer-incrementally t)
nit: s/#+BEGIN_SRC/#+begin_src, s/elisp/emacs-lisp/ From now on Doom will enforce two conventions for its org files for consistency's sake: - Lower-case meta-lines in org files, like #+begin_src, #+name, or #+end_quote (only exception are the top-level ones, like #+TITLE and #+STARTUP). - Use 'emacs-lisp' as the lang specifier for elisp blocks rather than 'elisp'. Emacs doesn't natively recognize the latter. This will be reflected in our rewritten docs/*.org and module README.org's.
2021-10-18 11:43:44 +02:00
#+end_src
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
**** package!
:PROPERTIES:
:added: 3.0.0-pre
:END:
#+begin_src emacs-lisp :eval no
;; To install a package that can be found on ELPA or any of the sources
;; specified in `straight-recipe-repositories':
(package! evil)
(package! js2-mode)
(package! rainbow-delimiters)
;; To disable a package included with Doom (which will no-op all its `after!'
;; and `use-package!' blocks):
(package! evil :disable t)
(package! rainbow-delimiters :disable t)
;; To install a package from a github repo
(package! so-long :recipe (:host github :repo "hlissner/emacs-so-long"))
;; If a package is particularly big and comes with submodules you don't need,
;; you can tell the package manager not to clone the repo recursively:
(package! ansible :recipe (:nonrecursive t))
;; To pin a package to a specific commit:
(package! evil :pin "e7bc39de2f9")
;; ...or branch:
(package! evil :recipe (:branch "stable"))
;; To unpin a pinned package:
(package! evil :pin nil)
;; If you share your config between two computers, and don't want bin/doom
;; refresh to delete packages used only on one system, use :ignore
(package! evil :ignore (not (equal system-name "my-desktop")))
#+end_src
*** doom-cli
**** TODO defcli!
**** TODO defcli-alias!
**** TODO defcli-obsolete!
**** TODO defcli-stub!
**** TODO defcli-autoload!
**** TODO defcli-group!
**** TODO exit!
**** TODO call!
**** TODO run!
**** TODO sh!
**** TODO sh!!
**** TODO git!
**** TODO def-cli-context-get
**** TODO def-cli-context-put
**** TODO def-cli-context-find-option
**** TODO def-cli-call
**** TODO def-cli-exit
**** TODO def-cli-load
**** TODO def-cli-load-all
**** TODO doom-cli-find
**** TODO doom-cli-get
**** TODO doom-cli-prop
**** TODO doom-cli-subcommands
**** TODO doom-cli-aliases
*** TODO lib/files.el
**** TODO doom-path
**** TODO doom-glob
**** TODO doom-dir
**** TODO doom-files-in
**** TODO doom-file-cookie-p
**** TODO file-exists-p!
**** TODO doom-file-size
**** TODO doom-file-line-count
**** TODO doom-directory-size
**** TODO doom-file-read
**** TODO doom-file-write
**** TODO with-file-contents!
** TODO Configuration files
refactor!: complete profile gen and init systems BREAKING CHANGE: This commit makes three breaking changes: - Doom now fully and dynamically generates (and byte-compiles) your profile and its init files, which includes your autoloads, loading your init files and modules, and then some. This replaces doom-initialize-modules, doom-initialize-core-modules, and doom-module-loader, which have been removed. This has also improved startup time by a bit, but if you use these functions in your CLIs, for instance, this will be a breaking change. - `doom sync` is now required for Doom to see your profiles (and must be run whenever you change them, or when you up/downgrade Emacs across major versions). - $DOOMDIR/init.el is now read much earlier than it used to be. Before any of doom-{ui,keybinds,editor,projects}, before any autoloads are loaded, and before your load-path has been populated with your packages. It now runs in the context of early-init.el, giving users freer range over what they can affect, but a more minimalistic environment to do it in. If you must have some logic run when all that is set up, add it to one of the module hooks added in e08f68b or 283308a. This also poses a significant change to Doom's load order (see the commentary change in lib/doom.el), along with the following (non breaking) changes: 1. Adds a new `doom profiles sync` command. This will forcibly resync your profiles, while `doom sync` will only do so if your profiles have changed. 2. Doom now fully and dynamically generates (and byte-compiles) your user-init-file, which includes loading all your init files, modules, and custom-file. This replaces the job of doom-initialize-modules, doom-initialize-core-modules, and doom-module-loader, which have been removed. This has also improved startup time by a bit. 3. Defines new doom-state-dir variable, though not used yet (saving that and the other breaking changes for the 3.0 release). 4. Redesigns profile directory variables (doom-profile-*-dir) to prepare for future XDG-compliance. 5. Removed unused/unimportant profile variables in doom.el. 6. Added lisp/doom-profiles.el. It's hardly feature complete, but it's enough to power the system as it is now. 7. Updates the "load order" commentary in doom.el to reflect these changes.
2022-09-15 18:53:06 +02:00
*** =profiles.el=
:PROPERTIES:
:ID: f9bce7da-d155-4727-9b6f-b566b5b8d824
:END:
This file can live in any of:
- =$DOOMDIR/profiles.el=
- =$EMACSDIR/profiles.el=
- =~/.config/doom-profiles.el=
- =~/.doom-profiles.el=
Here is an exhaustive example of all its syntax and capabilities:
#+begin_src emacs-lisp
;; -*- mode: emacs-lisp; -*-
((profile1
;; The permitted formats of each entry:
(var . value)
("envvar" . value)
(var :directive values...)
;; `user-emacs-directory' is often the first variable you want to set, so
;; Emacs knows where this profile lives. If you don't, it'll use the config
;; living in the default locations (~/.config/emacs or ~/.emacs.d).
(user-emacs-directory . "~/another/emacs/config/")
;; If this is a Doom config, you'll also want to set `doom-user-dir', which
;; defaults to ~/.config/doom or ~/.doom.d:
(doom-user-dir . "~/another/doom/config/")
;; If a CAR is a string, it is assumed you want to set an environment
;; variable. (Side-note: setting DOOMDIR will be unnecessary if you're setting
;; `doom-user-dir' above).
("DOOMDIR" . "~/another/doom/config/")
;; Doom profiles support a number of special directives. They are:
;;
;; (VAR :path SEGMENTS...) -- set VAR to an exapnded path built from SEGMENTS,
;; relative to `user-emacs-directory', unless an absolute path is in SEGMENTS.
(doom-cache-dir :path doom-user-dir ".local/cache")
(doom-data-dir :path doom-user-dir ".local/data")
(doom-state-dir :path doom-user-dir ".local/state")
;; (VAR :plist VALUE) -- use VALUE as a literal plist; ignoring any profile
;; directives that may be in it.
(some-plist :plist (:foo bar :baz womp))
;; (VAR :eval FORMS...) -- use to evaluate arbitrary elisp forms. Note that
;; his runs early in early-init.el. It's wise to assume no APIs are available
;; or loaded, only the previous bindings in this profile.
(doom-theme :eval (if (equal (system-name) "foo") 'doom-one 'doom-dracula))
;; Though discouraged, you may evaluate forms without a binding by using `_'.
;; You really should be doing this in the profile though...
(_ :eval (message "Hello world!"))
(_ :eval (with-eval-after-load 'company (setq-default company-idle-delay 2.0)))
;; (VAR :prepend FORMS...) or (VAR :append FORMS...) -- prepend or append the
;; evaluated result of each form in FORMS to VAR (a list). If VAR is undefined
;; at startup, it will be deferred until the variable is available.
(load-path :prepend (expand-file-name "packages/" doom-user-dir))
(load-path :prepend (expand-file-name "lisp/" doom-user-dir))
(load-path :append (expand-file-name "fallback/" doom-user-dir))
(exec-path :prepend (expand-file-name "bin/" doom-user-dir))
(auto-mode-alist :prepend '("\\.el\\'" . lisp-mode)))
(profile2
...)
(profile3
...))
#+end_src
*** =.doomprofile=
:PROPERTIES:
:ID: ac37ac6f-6082-4c34-b98c-962bc1e528c9
:END:
This file takes after the second level of =profiles.el='s format (see a more
complete example in [[id:f9bce7da-d155-4727-9b6f-b566b5b8d824][the previous section]]). For example:
#+begin_src emacs-lisp
;;; -*- mode: emacs-lisp -*-
;; A .doomprofile can be placed under an implicit profile. Same rules as
;; .doom-profiles.el, but one level deeper.
((var . value)
("envvar" . value)
(var :directive values...))
#+end_src
docs: add examples.org This adds the basic framework of docs/examples.org, including the former contents of demo.org in :lang emacs-lisp. elisp-demo has also been reconfigured to search it instead. Keep in mind that examples.org references a few things in as-of-yet published documentation. This will be rectified soon.
2022-09-12 17:11:16 +02:00
*** TODO =.doomrc=
*** TODO =.doomproject=
*** TODO =.doommodule=
** TODO Templates
*** TODO User configuration
*** TODO Module
*** TODO Project
*** TODO Theme
*** TODO Command-line interface
**** Unix utilities, rewritten as Doom scripts
To show off the syntax and capabilities of Doom's CLI framework, here are some
popular scripts ported to doomscripts for reference. They will all operate under
these assumptions:
1. The script lives somewhere in your =$PATH=,
2. =$EMACSDIR/bin/doomscript= lives in your =$PATH=.
3. The script is executable,
4. The script's filename matches the first argument of ~run!~ (by convention,
not a requirement),
***** ~mkdir~
#+begin_src emacs-lisp :eval no
#!/usr/bin/env doomscript
(defcli! mkdir
((mode ("-m" "--mode" mode))
(parents? ("-p" "--parents"))
(verbose? ("-v" "--verbose"))
&args directories)
"Create the DIRECTORIES, if do not already exist.
Mandatory arguments to long options are mandatory for short options too.
OPTIONS:
-m, --mode
set file mode (as in chmod), not a=rwx - umask.
-p, --parents
no error if existing, make parent directories as needed, with their file
modes unaffected by any `-m' option.
-v, --verbose
print a message for each created directory
AUTHOR:
Original program by David MacKenzie. Doomscript port by Henrik Lissner.
SEE ALSO:
`mkdir(2)`
Full documentation <https://www.gnu.org/software/coreutils/mkdir>
or available locally via: info '(coreutils) mkdir invocation'
Packaged by https://nixos.org
Copyright © 2022 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <https://gnu.org/li‐
censes/gpl.html>.
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law."
(dolist (dir directories)
(unless (file-directory-p dir)
(make-directory dir parents?)
(when mode
(set-file-modes dir mode))
(when verbose?
(print! "mkdir: created directory '%s'" dir)))))
#+end_src
****** Notes
- Docstrings for Doom CLIs recognize indented sections with a capitalized
heading followed by a colon (like ~SEE ALSO:~, ~OPTIONS:~, etc). They will be
appended to the --help output for this command. ~OPTIONS~ and ~ARGUMENTS~ are
special, in that they decorate pre-existing documentation for referenced
options/arguments.
- The options were documented in the CLI's docstring, instead of inline like so:
#+begin_src emacs-lisp
((mode ("-m" "--mode" mode) "set file modes (as in chmod), not a=rwx - umask.")
(parents? ("-p" "--parents") "no error if existing, make parent directories as needed, with their file modes unaffected by any `-m' option.")
(verbose? ("-v" "--verbose") "print a message for each created directory")
&args directories)
#+end_src
Either is acceptable, but for long docs like this, it's better suited to the
docstring. If both were present, Doom's help docs would have concatenated them
(separated by two newlines).
- The ~mode~ option takes one argument, a chmod mask. I indicate this with
~"`MODE'"~. This is a special syntax for highlighting arguments in the help
docs of this command. If I had used a symbol, instead (one of the predefined
types in [[var:][doom-cli-argument-value-types]]), I would've gotten free type-checking
and error handling, but there is no predefined type for chmod masks (yet), so
I'd have to do my own checks:
#+begin_src emacs-lisp :eval no
(defcli! mkdir
((mode ("-m" "--mode" "`MODE'"))
(parents? ("-p" "--parents"))
(verbose? ("-v" "--verbose"))
&args directories)
(unless (string-match-p "^[0-9]\\{3,4\\}$" mode)
(user-error "Invalid mode: %s" mode))
(setq mode (string-to-number mode 8))
(dolist (dir directories)
(unless (file-directory-p dir)
(make-directory dir parents?)
(when mode
(set-file-modes dir mode))
(when verbose?
(print! "mkdir: created directory '%s'" dir)))))
#+end_src
That said, set-file-modes will throw its own type error, but it likely won't
be as user friendly.
***** TODO ~say~
#+begin_src emacs-lisp :eval no
#!/usr/bin/env doomscript
(defcli! say
((name ("--speaker" name) "Who is speaking?")
&args args)
"This command repeats what you say to it.
It serves as an example of the bare minimum you need to write a Doom-based CLI.
Naturally, it could be more useful; it could process more complex options and
arguments, call other Doom CLIs, read/write data from files or over networks --
but that can wait for more complicated examples.
ARGUMENTS:
ARGS
The message to be repeated back at you.
OPTIONS:
--speaker
If not specified, it is assumed that Emacs is speaking."
(print! "%s says: %S"
(or name "Emacs")
(string-join args " ")))
(run! "say" (cdr (member "--" argv)))
#+end_src
#+begin_src bash :eval no
$ say hello world
Emacs says: "Hello world"
$ say --speaker Henrik "I've doomed us all"
Henrik says: "I've doomed us all"
$ say --help
TODO
#+end_src
***** emacs
This isn't useful, but it should hopefully demonstrate the full spectrum of
Doom's CLI, by reimplementing a subset of ~emacs~'s options and arguments (and
none of its documentation). It will simply forward them to the real program
afterwards.
Since I don't want to override the real ~emacs~ in the ~$PATH~, I'll just call
it ~demacs~:
#+begin_src emacs-lisp :eval no
#!/usr/bin/env doomscript
(defcli! demacs
((cd ("--chdir" dir))
(quick? ("-Q" "--quick"))
(no-init? ("-q" "--no-init-file"))
(no-slisp? ("-nsl" "--no-site-lisp"))
(no-sfile? ("--no-site-file"))
(initdir ("--init-directory" dir))
(batch? ("--batch"))
(batch (("-l" "--load" (file) ...))
(("-e" "--eval" (form) ...))
(("-f" "--funcall" (fn) ...))
(("-L" "--directory" (dir) ...))
(("--kill")))
(script ("--script" (file)))
&args (args (file linecol)))
"Demacs is a thin wrapper around Emacs, made to demo of Doom's CLI Framework.
Since documentation isn't the focus of this example, this is all you'll get!"
(cond (script (load script))
(batch?
(dolist (do batch)
(pcase do
(`(,(or "-l" "--load") . ,file) (load file))
(`(,(or "-e" "--eval") . ,form) (eval (read form) t))
(`(,(or "-f" "--funcall") . ,fn) (funcall (read fn)))
(`("--kill" . t) (kill-emacs 0)))))
((exit! :then (cons "emacs"
(append (if quick '("-Q"))
(if no-init? '("-q"))
(if no-slisp? '("-nsl"))
(if no-sfile? '("--no-site-file"))
(if initdir `("--init-directory" ,initdir))
args))))))
#+end_src
****** Notes
There's a lot of (intentional) redundancy here, for posterity. A *much* simpler
(and more reliable) version of this command would've looked like this:
#+begin_src emacs-lisp
(defcli! demacs (&rest args)
(exit! :then (cons "emacs" args)))
#+end_src
But that wouldn't demonstrate enough. Though, it wouldn't forward ~--version~ or
~--help~ either.
** TODO Use cases
*** TODO Note-taking
*** TODO Game development
*** TODO Web development
*** TODO Emacs as your terminal
Reference in a new issue Copy permalink