75 lines
2.3 KiB
Org Mode
75 lines
2.3 KiB
Org Mode
#+title: :ui deft
|
|
#+subtitle: Notational velocity for Emacs
|
|
#+created: August 26, 2018
|
|
#+since: 21.12.0 (#835)
|
|
|
|
* Description :unfold:
|
|
[[https://jblevins.org/projects/deft/][Deft]] is a major mode for creating, browsing, and filtering notes written in
|
|
plain text formats, such as org-mode, markdown, and LaTeX. It enables you to
|
|
quickly jot down thoughts and easily retrieve them later.
|
|
|
|
** Maintainers
|
|
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
|
|
|
** Module flags
|
|
/This module has no flags./
|
|
|
|
** Packages
|
|
- [[doom-package:deft]]
|
|
|
|
** Hacks
|
|
/No hacks documented for this module./
|
|
|
|
** TODO Changelog
|
|
# This section will be machine generated. Don't edit it by hand.
|
|
/This module does not have a changelog yet./
|
|
|
|
* Installation
|
|
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
|
|
|
/This module has no external requirements./
|
|
|
|
* TODO Usage
|
|
#+begin_quote
|
|
This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
|
|
#+end_quote
|
|
|
|
* TODO Configuration
|
|
#+begin_quote
|
|
/This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
|
#+end_quote
|
|
|
|
To use deft, you first need to specify the directory in which your notes are
|
|
stored:
|
|
#+begin_src emacs-lisp
|
|
;; in $DOOMDIR/config.el
|
|
(setq deft-directory "~/notes")
|
|
#+end_src
|
|
|
|
The default note format is org-mode. You can change this by setting the value of
|
|
the variable ~deft-default-extension~. Replacing the value with ~"md"~, for
|
|
example, will change the default note format to markdown:
|
|
#+begin_src emacs-lisp
|
|
(after! deft
|
|
(setq deft-default-extension "md"))
|
|
#+end_src
|
|
|
|
You may also want to alter the way titles and file names are automatically
|
|
created by editing ~deft-use-filename-as-title~ and/or
|
|
~deft-use-filter-string-for-filename~.
|
|
|
|
Further customization options can be found here:
|
|
https://github.com/jrblevin/deft#other-customizations
|
|
|
|
* Troubleshooting
|
|
[[doom-report:][Report an issue?]]
|
|
|
|
- It is [[https://github.com/hlissner/doom-emacs/pull/2845/commits/dce80a3c8032f5390f4e763e18a108d5f3f08772][not recommended]] to re-enable deft's buffer auto-save.
|
|
|
|
* Frequently asked questions
|
|
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
|
|
|
|
* TODO Appendix
|
|
#+begin_quote
|
|
This module has no appendix yet. [[doom-contrib-module:][Write one?]]
|
|
#+end_quote
|