Skip to content

Commit 10f99e9

Browse files
committed
docs(DOCS.md): improve readability
1 parent 1473218 commit 10f99e9

File tree

1 file changed

+35
-35
lines changed

1 file changed

+35
-35
lines changed

DOCS.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -345,9 +345,9 @@ Example:<br />
345345
default value: `{ t = { description = 'Task', template = '* TODO %?\n %u' } }`<br />
346346
Templates for capture/refile prompt.<br />
347347
Variables:
348-
- `%f`: Prints the file of the buffer capture was called from
349-
- `%F`: Like `%f` but inserts the full path
350-
- `%n`: Inserts the current `$USER`
348+
* `%f`: Prints the file of the buffer capture was called from
349+
* `%F`: Like `%f` but inserts the full path
350+
* `%n`: Inserts the current `$USER`
351351
* `%t`: Prints current date (Example: `<2021-06-10 Thu>`)
352352
* `%T`: Prints current date and time (Example: `<2021-06-10 Thu 12:30>`)
353353
* `%u`: Prints current date in inactive format (Example: `[2021-06-10 Thu]`)
@@ -357,7 +357,7 @@ Variables:
357357
* `%x`: Insert content of the clipboard via the "+" register (see :help clipboard)
358358
* `%?`: Default cursor position when template is opened
359359
* `%^{PROMPT|DEFAULT|COMPLETION...}`: Prompt for input, if completion is provided an :h inputlist will be used
360-
- `%(EXP)`: Runs the given lua code and inserts the result
360+
* `%(EXP)`: Runs the given lua code and inserts the result
361361

362362
Example:<br />
363363
`{ T = { description = 'Todo', template = '* TODO %?\n %u', target = '~/org/todo.org' } }`
@@ -366,9 +366,9 @@ Journal example:<br />
366366
`{ j = { description = 'Journal', template = '\n*** %<%Y-%m-%d> %<%A>\n**** %U\n\n%?', target = '~/sync/org/journal.org' } }`
367367

368368
Nested key example:<br />
369-
`{ e = 'Event' }`
370-
`{ er = { description = 'recurring', template = '** %?\n %T', target = '~/org/calendar.org', headline = 'recurring' } }`
371-
`{ eo = { description = 'one-time', template = '** %?\n %T', target = '~/org/calendar.org', headline = 'one-time' } }`
369+
- `{ e = 'Event' }`
370+
- `{ er = { description = 'recurring', template = '** %?\n %T', target = '~/org/calendar.org', headline = 'recurring' } }`
371+
- `{ eo = { description = 'one-time', template = '** %?\n %T', target = '~/org/calendar.org', headline = 'one-time' } }`
372372

373373
#### **org_agenda_min_height**
374374
*type*: `number`<br />
@@ -423,8 +423,8 @@ Example value: `{'agenda-archives'}`
423423
### Tags settings
424424

425425
#### **org_tags_column**
426-
*type*: `number`
427-
*default value*: `80`
426+
*type*: `number`<br />
427+
*default value*: `80`<br />
428428
The column to which tags should be indented in a headline.
429429
If this number is positive, it specifies the column.
430430
If it is negative, it means that the tags should be flushright to that column.
@@ -474,7 +474,7 @@ require('orgmode').setup({
474474
There are only 2 global mappings that are accessible from everywhere.
475475

476476
#### **org_agenda**
477-
*mapped to*: <kbd>\<Leader\>oa</kbd><br />
477+
*mapped to*: `<Leader\>oa`<br />
478478
Opens up agenda prompt.
479479

480480
#### **org_capture**
@@ -1010,34 +1010,34 @@ For adding/changing TODO keyword colors see [org-todo-keyword-faces](#org_todo_k
10101010
* The following highlight groups are based on _Treesitter_ query results, hence when setting up _Orgmode_ these
10111011
highlights must be enabled by removing `disable = {'org'}` from the default recommended _Treesitter_ configuration.
10121012

1013-
`OrgTSTimestampActive`: An active timestamp
1014-
`OrgTSTimestampInactive`: An inactive timestamp
1015-
`OrgTSBullet`: A normal bullet under a header item
1016-
`OrgTSPropertyDrawer`: Property drawer start/end delimiters
1017-
`OrgTSDrawer`: Drawer start/end delimiters
1018-
`OrgTSTag`: A tag for a headline item, shown on the righthand side like `:foo:`
1019-
`OrgTSPlan`: `SCHEDULED`, `DEADLINE`, `CLOSED`, etc. keywords
1020-
`OrgTSComment`: A comment block
1021-
`OrgTSDirective`: Blocks starting with `#+`
1022-
`OrgTSCheckbox`: The default checkbox highlight, overridden if any of the below groups are specified
1023-
`OrgTSCheckboxChecked`: A checkbox checked with either `[x]` or `[X]`
1024-
`OrgTSCheckboxHalfChecked`: A checkbox checked with `[-]`
1025-
`OrgTSCheckboxUnchecked`: A empty checkbox
1026-
`OrgTSHeadlineLevel1`: Headline at level 1
1027-
`OrgTSHeadlineLevel2`: Headline at level 2
1028-
`OrgTSHeadlineLevel3`: Headline at level 3
1029-
`OrgTSHeadlineLevel4`: Headline at level 4
1030-
`OrgTSHeadlineLevel5`: Headline at level 5
1031-
`OrgTSHeadlineLevel6`: Headline at level 6
1032-
`OrgTSHeadlineLevel7`: Headline at level 7
1033-
`OrgTSHeadlineLevel8`: Headline at level 8
1013+
* `OrgTSTimestampActive`: An active timestamp
1014+
* `OrgTSTimestampInactive`: An inactive timestamp
1015+
* `OrgTSBullet`: A normal bullet under a header item
1016+
* `OrgTSPropertyDrawer`: Property drawer start/end delimiters
1017+
* `OrgTSDrawer`: Drawer start/end delimiters
1018+
* `OrgTSTag`: A tag for a headline item, shown on the righthand side like `:foo:`
1019+
* `OrgTSPlan`: `SCHEDULED`, `DEADLINE`, `CLOSED`, etc. keywords
1020+
* `OrgTSComment`: A comment block
1021+
* `OrgTSDirective`: Blocks starting with `#+`
1022+
* `OrgTSCheckbox`: The default checkbox highlight, overridden if any of the below groups are specified
1023+
* `OrgTSCheckboxChecked`: A checkbox checked with either `[x]` or `[X]`
1024+
* `OrgTSCheckboxHalfChecked`: A checkbox checked with `[-]`
1025+
* `OrgTSCheckboxUnchecked`: A empty checkbox
1026+
* `OrgTSHeadlineLevel1`: Headline at level 1
1027+
* `OrgTSHeadlineLevel2`: Headline at level 2
1028+
* `OrgTSHeadlineLevel3`: Headline at level 3
1029+
* `OrgTSHeadlineLevel4`: Headline at level 4
1030+
* `OrgTSHeadlineLevel5`: Headline at level 5
1031+
* `OrgTSHeadlineLevel6`: Headline at level 6
1032+
* `OrgTSHeadlineLevel7`: Headline at level 7
1033+
* `OrgTSHeadlineLevel8`: Headline at level 8
10341034

10351035
* The following use vanilla _Vim_ syntax matching, and will work without _Treesitter_ highlighting enabled.
10361036

1037-
`OrgEditSrcHighlight`: The highlight for the source content in an _Org_ buffer while it is being edited in an edit special buffer
1038-
`OrgAgendaDeadline`: A item deadline in the agenda view
1039-
`OrgAgendaScheduled`: A scheduled item in the agenda view
1040-
`OrgAgendaScheduledPast`: A item past its scheduled date in the agenda view
1037+
* `OrgEditSrcHighlight`: The highlight for the source content in an _Org_ buffer while it is being edited in an edit special buffer
1038+
* `OrgAgendaDeadline`: A item deadline in the agenda view
1039+
* `OrgAgendaScheduled`: A scheduled item in the agenda view
1040+
* `OrgAgendaScheduledPast`: A item past its scheduled date in the agenda view
10411041

10421042
## Advanced search
10431043
Part of [Advanced search](https://orgmode.org/worg/org-tutorials/advanced-searching.html) functionality

0 commit comments

Comments
 (0)