1 Side Notes
2 ==========
3 
4 [![MELPA Stable](https://stable.melpa.org/packages/side-notes-badge.svg)][1]
5 [![MELPA](https://melpa.org/packages/side-notes-badge.svg)][2]
6 
7 Quickly display your quick side notes in quick side window.
8 
9 Side notes live in a plain text file, called `notes.txt` by default, in
10 the current directory or any parent directory (i.e. when locating notes,
11 we first look in the current directory, then one directory up, then two
12 directories up, and so forth.)
13 
14 Side notes are displayed in a side window with the command
15 `side-notes-toggle-notes`.
16 
17 The filename is defined by user option `side-notes-file`.
18 
19 To really mix things up, there's the user option
20 `side-notes-secondary-file`, which defaults to `notes-2.txt`, and will
21 display a separate notes file in a lower side window when the command
22 `side-notes-toggle-notes` is prefixed with an argument (`C-u`).
23 
24 By default a notes file found in any parent directory will open that
25 file rather than visit a non-existing file in the current directory, but
26 you can override this by prefixing `side-notes-toggle-notes` with...
27 
28  - `C-u C-u` to force visiting `side-notes-file` within the current
29    directory.
30  - `C-u C-u C-u` to force visiting `side-notes-secondary-file` within
31    the current directory.
32 
33 Of course, you can use Markdown or Org Mode or whatever by changing the
34 file extensions of `side-notes-file` and/or `side-notes-secondary-file`.
35 
36 For more information on how to change the way the side window is
37 displayed, see `(info "(elisp) Side Windows")`.
38 
39 
40 Installation
41 ------------
42 
43 Install from [MELPA stable][1] then add something like the following to
44 your init file:
45 
46     (define-key (current-global-map) (kbd "M-s n") #'side-notes-toggle-notes)
47 
48 
49 Bugs and Feature Requests
50 -------------------------
51 
52 Send me an email (address in the package header). For bugs, please
53 ensure you can reproduce with:
54 
55     $ emacs -Q -l side-notes.el
56 
57 Known issues are tracked with `FIXME` comments in the source.
58 
59 
60 [1]: https://stable.melpa.org/#/side-notes
61 [2]: https://melpa.org/#/side-notes