Difference between revisions of "Deft"

From WikEmacs
Jump to: navigation, search
(added basic deft page)
 
(Use Org for Deft Files: type)
 
(11 intermediate revisions by 4 users not shown)
Line 2: Line 2:
 
|name=Deft
 
|name=Deft
 
|description=note taking mode
 
|description=note taking mode
 +
|author=Jason Blevins
 
|maintainer=Jason Blevins
 
|maintainer=Jason Blevins
 
|source=git://jblevins.org/git/deft.git
 
|source=git://jblevins.org/git/deft.git
 
}}
 
}}
  
'''Deft''' is an Emacs mode for quickly browsing, filtering, and editing directories of plain text notes, inspired by Notational Velocity. It was designed for increased productivity when writing and taking notes by making it fast and simple to find the right file at the right time and by automating many of the usual tasks such as creating new files and saving files.
+
[[Deft]] is an Emacs mode for quickly browsing, filtering, and editing directories of plain text notes. It is inspired by the OS X app [http://notational.net/ Notational Velocity] (see also [http://brettterpstra.com/project/nvalt/ nvAlt]). Deft is designed for increased productivity when writing and taking notes, by making it fast and simple to find the right file at the right time
 +
and by automating many of the usual tasks such as creating new files and saving files
  
= Basic setup =
+
== Basic setup ==
  
 
<source lang="lisp">
 
<source lang="lisp">
Line 14: Line 16:
 
</source>
 
</source>
  
= Helpful keybindings =
+
== Helpful keybindings ==
  
= Common Customization =
+
In the {{Buffer|*Deft*}} buffer you can start typing to filter the list of notes.
  
= See Also =
+
; {{Keys|C-c C-c|deft-filter-clear}}
 +
: clear the filter
 +
; {{Keys|C-c C-n|deft-new-file}}
 +
: quickly create a new note
 +
 
 +
== Common Customization ==
 +
 
 +
You can bind deft to a single key for quick access to notes:
 +
{{Snippet|(global-set-key (kbd "<F8>") 'deft)}}
 +
 
 +
=== Use Org for Deft Files ===
 +
 
 +
To use [[Org]] mode for your [[Deft]] files, add the following to your {{EmacsConfigFile}}: {{Snippet|(setq deft-text-mode 'org-mode)}}.
 +
 
 +
Then do '''one''' of the following:
 +
* Configure Deft to use <tt>.org</tt> as the file extension:
 +
:{{Snippet|(setq deft-extension "org")}}
 +
* Associate Org mode with <tt>.txt</tt> files, or just with <tt>.txt</tt> files in a specific directory (e.g. {{Directory|notes}} as shown here)
 +
:{{Snippet|(add-to-list 'auto-mode-alist '("notes/.*[.]txt$" . org-mode))}}
 +
 
 +
=== Deft with Dropbox and SimpleNote===
 +
 
 +
[[Deft]] notes can be stored in the cloud using something like [https://www.dropbox.com/ Dropbox]. Simply configure Deft to use a directory that is being synced:
 +
{{Snippet|(setq deft-directory "~/Dropbox/notes/")}}
 +
 
 +
If you use the online service [http://simplenoteapp.com SimpleNote] (e.g. to read and capture notes on an iOS device) you can combine this with Dropbox sync and Deft. SimpleNote looks for <tt>.txt</tt> files and uses the file name as the note title, so configure Deft to do the same:
 +
 
 +
<source lang="lisp">
 +
(setq deft-extension "txt")
 +
(setq deft-use-filename-as-title t)
 +
</source>
 +
 
 +
== See Also ==
  
 
* [[Org]]
 
* [[Org]]
 
* [[Markdown]]
 
* [[Markdown]]
  
= Project Pages =
+
== Project Pages ==
 
* [http://jblevins.org/projects/deft/ Official project page]
 
* [http://jblevins.org/projects/deft/ Official project page]
 
* [git://jblevins.org/git/deft.git Git Repo]
 
* [git://jblevins.org/git/deft.git Git Repo]
  
= Tutorial Pages =
+
== Tutorial Pages ==
  
[[Category:Project Management]][[Category:Convenience]][[Category:Third Party Package]]
+
[[Category:Convenience]]
 +
[[Category:Third Party Package]]
 +
[[Category:GTD]]

Latest revision as of 15:45, 2 April 2012

Deft
Description note taking mode
Author Jason Blevins
Maintainer Jason Blevins
Source git://jblevins.org/git/deft.git

Deft is an Emacs mode for quickly browsing, filtering, and editing directories of plain text notes. It is inspired by the OS X app Notational Velocity (see also nvAlt). Deft is designed for increased productivity when writing and taking notes, by making it fast and simple to find the right file at the right time and by automating many of the usual tasks such as creating new files and saving files

Basic setup[edit]

(require 'deft)

Helpful keybindings[edit]

In the "*Deft*" buffer you can start typing to filter the list of notes.

[C-c C-c]
clear the filter
[C-c C-n]
quickly create a new note

Common Customization[edit]

You can bind deft to a single key for quick access to notes:

(global-set-key (kbd "<F8>") 'deft)

Use Org for Deft Files[edit]

To use Org mode for your Deft files, add the following to your Emacs configuration file:
(setq deft-text-mode 'org-mode)
.

Then do one of the following:

  • Configure Deft to use .org as the file extension:
(setq deft-extension "org")
  • Associate Org mode with .txt files, or just with .txt files in a specific directory (e.g. notes/ as shown here)
(add-to-list 'auto-mode-alist '("notes/.*[.]txt$" . org-mode))

Deft with Dropbox and SimpleNote[edit]

Deft notes can be stored in the cloud using something like Dropbox. Simply configure Deft to use a directory that is being synced:

(setq deft-directory "~/Dropbox/notes/")

If you use the online service SimpleNote (e.g. to read and capture notes on an iOS device) you can combine this with Dropbox sync and Deft. SimpleNote looks for .txt files and uses the file name as the note title, so configure Deft to do the same:

(setq deft-extension "txt")
(setq deft-use-filename-as-title t)

See Also[edit]

Project Pages[edit]

Tutorial Pages[edit]