doomemacs/modules/ui/deft/README.org
Henrik Lissner 6f40ad55f5
docs: discourage after! and use-package! use
There's little reason for users to use these macros in their private
configs over plain ol' `with-eval-after-load` and `use-package`, unless
they're writing their own modules.

It's my fault for signal boosting them in documentation and whenever I'm
asked for help, because beginners now believe they are somehow
required for Doom to work correctly (there are guides out there
telling beginners that migrating to Doom involves replacing all
instances of `with-eval-after-load` and `use-package` in their
pre-existing configs with `after!` and `use-package!` -- which was never
true).

What's more, I plan to replace `use-package`, internally, so the
`use-package!` macro won't exist for much longer.
2026-02-09 04:29:47 -05:00

2.3 KiB

:ui deft

Description   unfold

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. Become a maintainer?

Module flags

This module has no flags.

Hacks

No hacks documented for this module.

TODO Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

This module has no external requirements.

TODO Usage

󱌣 This module has no usage documentation yet. Write some?

TODO Configuration

󱌣 This module's configuration documentation is incomplete. Complete it?

To use deft, you first need to specify the directory in which your notes are stored:

;; in $DOOMDIR/config.el
(setq deft-directory "~/notes")

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:

(with-eval-after-load 'deft
  (setq deft-default-extension "md"))

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

Report an issue?

Frequently asked questions

This module has no FAQs yet. Ask one?

TODO Appendix

󱌣 This module has no appendix yet. Write one?