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