Skip to content

Commit 88b9335

Browse files
committed
chore(guide): add more markdown syntax examples
1 parent 8be3a57 commit 88b9335

File tree

3 files changed

+84
-19
lines changed

3 files changed

+84
-19
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,18 @@ Tasks can be outputted to `stdout` using the `tasks` subcommand.
204204
omm tasks
205205
```
206206

207+
🤔 Tips
208+
---
209+
210+
These are some tips to improve your experience of using `omm`:
211+
212+
- Set up discrete instances of `omm` if you need to. You can do so by
213+
referencing a different config file (which points to a unique database) for
214+
each instance, or by directly using `--db-path` flag. Eg. an omm instance for
215+
personal tasks, and another for work. Set up as many `omm` instances as you
216+
need.
217+
- Use `omm updates` to stay up to date with omm's latest features/changes.
218+
207219
⌨️ Keymaps
208220
---
209221

Lines changed: 56 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,67 @@
11
Context can (optionally) be written in markdown, which will get rendered
22
accordingly.
33

4-
For example:
4+
Open this context in the task details pane (press `d`) to view it in its
5+
entirety.
6+
7+
---
58

69
# This is an H1 heading
710

811
## This is an H2 heading
912

13+
### This is an H3 heading
14+
15+
---
16+
17+
`code` emphasis looks like this.
18+
19+
---
20+
1021
```go
11-
// a comment
22+
// this is a code block
1223
fmt.Print("This is a code block")
1324
```
25+
---
26+
27+
**bold text looks like this**
28+
29+
---
30+
31+
*and italic like this*
32+
33+
---
34+
35+
This is a URL: [omm](https://github.com/dhth/omm)
36+
37+
---
38+
39+
> This is a block quote
40+
> that spans
41+
> multiple lines
42+
43+
---
44+
45+
Tables render like this:
46+
47+
| Syntax | Description | Test Text |
48+
| :--- | :----: | ---: |
49+
| Header | Title | Here's this |
50+
| Paragraph | Text | And more |
51+
52+
---
53+
54+
You can ~~strikethrough~~ words.
55+
56+
---
57+
58+
- [x] this is a task list
59+
- [x] inside a task list app
60+
- [ ] pretty meta
61+
62+
---
63+
64+
- Lists
65+
- Render
66+
- Like
67+
- This

internal/utils/assets/gruvbox.json

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
},
88
"block_quote": {
99
"indent": 1,
10-
"indent_token": " "
10+
"indent_token": " "
1111
},
1212
"paragraph": {},
1313
"list": {
@@ -50,12 +50,12 @@
5050
"crossed_out": true
5151
},
5252
"emph": {
53-
"italic": true,
54-
"color": "#83a598"
53+
"color": "#83a598",
54+
"italic": true
5555
},
5656
"strong": {
57-
"bold": true,
58-
"color": "#fe8019"
57+
"color": "#fe8019",
58+
"bold": true
5959
},
6060
"hr": {
6161
"color": "#928374",
@@ -140,10 +140,11 @@
140140
"color": "#b8bb26"
141141
},
142142
"name_class": {
143-
"color": "#fe8019",
144-
"bold": true
143+
"color": "#fe8019"
144+
},
145+
"name_constant": {
146+
"color": "#d3869b"
145147
},
146-
"name_constant": {},
147148
"name_decorator": {
148149
"color": "#d3869b"
149150
},
@@ -166,26 +167,24 @@
166167
"color": "#83a598"
167168
},
168169
"generic_deleted": {
169-
"color": "#fb4934",
170-
"background_color": "#282828"
170+
"color": "#fb4934"
171171
},
172172
"generic_emph": {
173-
"italic": true,
174-
"color": "#83a598"
173+
"color": "#83a598",
174+
"italic": true
175175
},
176176
"generic_inserted": {
177-
"color": "#b8bb26",
178-
"background_color": "#282828"
177+
"color": "#b8bb26"
179178
},
180179
"generic_strong": {
181-
"bold": true,
182-
"color": "#ebdbb2"
180+
"color": "#ebdbb2",
181+
"bold": true
183182
},
184183
"generic_subheading": {
185184
"color": "#b8bb26"
186185
},
187186
"background": {
188-
"background_color": "#3c3836"
187+
"background_color": "#282828"
189188
}
190189
}
191190
},

0 commit comments

Comments
 (0)