@@ -17,47 +17,35 @@ This is just one tool in the chain. `notes` is a command line tool, and some peo
17
17
18
18
Download ` notes ` , ` chmod +x ` , put it in your ` $path ` . This will probably do it:
19
19
20
- ```
20
+ ``` bash
21
21
curl https://cdn.rawgit.com/pimterry/notes/v0.1.0/notes > /usr/local/bin/notes
22
22
```
23
23
24
24
By default your notes live in ~ /notes, but you can change that to anywhere you like by setting the ` $NOTES_DIRECTORY ` environmental variable.
25
25
26
26
## How do I use it?
27
27
28
- ```
29
- notes new <note-name>
30
- ```
28
+ ### ` notes new <note-name> `
31
29
32
30
Opens your ` $EDITOR ` of choice for a new note, with the given name. The name can include slashes, if you want put your note in a subfolder.
33
31
34
- ```
35
- notes find <part-of-a-note's-name>
36
- ```
32
+ ### ` notes find <part-of-a-note-name> `
37
33
38
34
Searches note filenames and paths for the given string, and returns all the matches.
39
35
40
- ```
41
- notes grep <part-of-a-note's-content>
42
- ```
36
+ ### ` notes grep <part-of-some-note-content> `
43
37
44
38
Searches all note content for the given string and returns all the matches.
45
39
46
- ```
47
- notes open
48
- ```
40
+ ### ` notes open `
49
41
50
42
Opens your notes folder in your default configured file explorer.
51
43
52
- ```
53
- notes open <note-name>
54
- ```
44
+ ### ` notes open <note-name> `
55
45
56
46
Opens a given note in your ` $EDITOR ` . Name can be an absolute path, or a relative path in your notes (.md suffix optional).
57
47
58
- ```
59
- notes grep/find <pattern> | notes open
60
- ```
48
+ ### ` notes grep/find <pattern> | notes open `
61
49
62
50
Combine these together! This opens each matching note in your ` $EDITOR ` in turn.
63
51
@@ -89,4 +77,4 @@ If you submit a PR, please make sure it:
89
77
90
78
* Doesn't break existing tests
91
79
* Adds new tests, if appropriate
92
- * Adds new documentation, if appropriate
80
+ * Adds new documentation, if appropriate
0 commit comments