Commit
Author: Kevin Schoon [kevinschoon@gmail.com]
Hash: 6fb8a7478ee52175a2e9559d9a6eb4a885b560e8
Timestamp: Thu, 17 Sep 2020 21:03:28 +0000 (4 years ago)

+32 -0 +/-2 browse
update docs
1diff --git a/doc/note.5 b/doc/note.5
2index 5430ed6..01dad4a 100644
3--- a/doc/note.5
4+++ b/doc/note.5
5 @@ -27,6 +27,23 @@ Today will be a nice day\&.
6 .fi
7 .RE
8 .P
9+ .SS The State Directory
10+ .P
11+ Each note is stored as a flat file inside the `state_dir` with a slug that corresponds to the
12+ date (YYYYMMDD) on which it was created.\& If multiple notes are created on one day, an index will
13+ be appended to the file.\&
14+ .P
15+ .nf
16+ .RS 4
17+ $ tree ~/\&.local/share/note/
18+ /home/kevin/\&.local/share/note/
19+ ├── note-20200818-1\&.md
20+ ├── note-20200819-1\&.md
21+ ├── note-20200819-2\&.md
22+ └── note-20200819-3\&.md
23+ .fi
24+ .RE
25+ .P
26 .SS Configuration
27 .P
28 The behavior of \fBnote\fR can be configured with yaml file stored in \fB~/.\&config/note/config.\&yaml\fR and configure itself per the XDG Base Directory specification, see https://specifications.\&freedesktop.\&org/basedir-spec/basedir-spec-latest.\&html.\& You can view the resolved configuration by running \fBnote config\fR:
29 diff --git a/doc/note.5.scd b/doc/note.5.scd
30index a1dbdd3..14b2243 100644
31--- a/doc/note.5.scd
32+++ b/doc/note.5.scd
33 @@ -18,6 +18,21 @@ tags: [ocaml, programming]
34 Today will be a nice day.
35 ```
36
37+ ## The State Directory
38+
39+ Each note is stored as a flat file inside the `state_dir` with a slug that corresponds to the
40+ date (YYYYMMDD) on which it was created. If multiple notes are created on one day, an index will
41+ be appended to the file.
42+
43+ ```
44+ $ tree ~/.local/share/note/
45+ /home/kevin/.local/share/note/
46+ ├── note-20200818-1.md
47+ ├── note-20200819-1.md
48+ ├── note-20200819-2.md
49+ └── note-20200819-3.md
50+ ```
51+
52 ## Configuration
53
54 The behavior of *note* can be configured with yaml file stored in *~/.config/note/config.yaml* and configure itself per the XDG Base Directory specification, see https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html. You can view the resolved configuration by running *note config*: