docs(:ui): update READMEs to new format
This commit is contained in:
parent
6da20e45bd
commit
b5a2aa48fe
25 changed files with 1533 additions and 922 deletions
|
@ -1,51 +1,77 @@
|
|||
#+TITLE: ui/deft
|
||||
#+DATE: August 27, 2018
|
||||
#+SINCE: v2.0.9
|
||||
#+STARTUP: inlineimages nofold
|
||||
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::ui deft][Issues]] ↖ [[doom-module-source:ui/deft][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||
--------------------------------------------------------------------------------
|
||||
#+TITLE: :ui deft
|
||||
#+SUBTITLE: Notational velocity for Emacs
|
||||
#+CREATED: August 26, 2018
|
||||
#+SINCE: 21.12.0 (#835)
|
||||
|
||||
* Table of Contents :TOC_3:noexport:
|
||||
- [[#description][Description]]
|
||||
- [[#maintainers][Maintainers]]
|
||||
- [[#module-flags][Module Flags]]
|
||||
- [[#plugins][Plugins]]
|
||||
- [[#prerequisites][Prerequisites]]
|
||||
- [[#configuration][Configuration]]
|
||||
- [[#troubleshooting][Troubleshooting]]
|
||||
|
||||
* Description
|
||||
[[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.
|
||||
* 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.
|
||||
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
** Module Flags
|
||||
This module provides no flags.
|
||||
** Module flags
|
||||
/This module has no flags./
|
||||
|
||||
** Plugins
|
||||
+ [[https://github.com/jrblevin/deft][deft]]
|
||||
** Packages
|
||||
- [[doom-package:][deft]]
|
||||
|
||||
* Prerequisites
|
||||
This module has no prerequisites.
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
||||
* Configuration
|
||||
To use deft, you first need to specify the directory in which your notes are stored:
|
||||
** TODO Changelog
|
||||
# This section will be machine generated. Don't edit it by hand.
|
||||
/This module does not have a changelog yet./
|
||||
|
||||
#+begin_src elisp
|
||||
;; ~/.doom.d/config.el
|
||||
* 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 elisp
|
||||
(setq deft-default-extension "md")
|
||||
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~.
|
||||
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
|
||||
Further customization options can be found here:
|
||||
https://github.com/jrblevin/deft#other-customizations
|
||||
|
||||
* Troubleshooting
|
||||
It is [[https://github.com/hlissner/doom-emacs/pull/2845/commits/dce80a3c8032f5390f4e763e18a108d5f3f08772][not recommended]] to re-enable deft's buffer auto-save.
|
||||
[[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
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue