Skip to content

Commit 9d0f3cd

Browse files
committed
Updated README
1 parent 76e7e74 commit 9d0f3cd

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@ to bold (`iw` is a text-objext).
3939
Then, while letting the cursor on the bold text, hit `<localleader>d`
4040
to remove it.
4141

42-
Next, try to do the same with arbitrary motion and by replacing `b` with `i`
43-
for italics, `s` for strike-through, `c` for code, etc.
42+
Next, try to do the same with arbitrary text-objects or in Visual mode by
43+
replacing `b` with `i` for italics, `s` for strike-through, `c` for code, etc.
4444

4545
You can also highlight text with `<localleader>h`. However, the highlight is
4646
not persistent. As usual, you can remove the highlight with `<localleader>d`.
4747

48-
See `markdown-extras-mappings` for all the possible text styles.
48+
See `:h markdown-extras-mappings` for all the possible text styles.
4949

5050
### Links
5151

@@ -71,7 +71,7 @@ In case you are working on a markdown file with mixed inline and
7171
reference-style links, you can convert the former to the latter by using
7272
`:MDEConvertLinks` command. All the newly created links will be placed after
7373
the `<!-- DO NOT REMOVE vim-markdown-extras references DO NOT REMOVE-->`
74-
comment line.
74+
comment line. The reference identifiers are numbers.
7575

7676
> [!Note]
7777
>
@@ -90,7 +90,7 @@ matter of customizing everything to your workflow, no? :)
9090

9191
You can create to-do lists as you would do in normal markdown, by starting
9292
lines with `- [ ]` . When in normal mode, you can check/uncheck the item in the
93-
to-do list with `<localleader>x`.
93+
to-do list with `<localleader>x` in normal mode.
9494

9595
> [!Note]
9696
>
@@ -103,7 +103,7 @@ You can format text as usual by using `gq`.
103103
Here `gq` uses `prettier`, provided that you have it installed.
104104
That is, if you use `gq` plus motion, or if you visually select some text and
105105
then hit `gq`, then `prettier` will only prettify such a portion of text. You
106-
can also prettify the whole buffer on save, see `markdown-extras-config` how
106+
can also prettify the whole buffer on save, see `:h markdown-extras-config` how
107107
to do that.
108108

109109
### Rendering
@@ -135,7 +135,7 @@ You could for example set the following:
135135
As the plugin can be used for note-taking, it may be desirable to access
136136
different indices in an ergonomic way. This can be achieved with the
137137
`g:markdown_extras_indices` list in combination with the `:MDEIndices`
138-
command.
138+
command. `g:markdown_extras_indices` is nothing, but a list of files.
139139

140140
For more information about key-bindings, configuration, etc. take
141141
a look at `:h markdown-extras`.
@@ -158,7 +158,7 @@ limitations:
158158
identifiers, but I won't guarantee that everything will work fine.
159159

160160
- The link management system heavily relies on the content below the
161-
"<!-- DO NOT REMOVE vim-markdown-extras references DO NOT REMOVE -->"
161+
`<!-- DO NOT REMOVE vim-markdown-extras references DO NOT REMOVE -->`
162162
comment. That comment must be unique. Attempting to pick links randomly
163163
scattered throughout the buffer using regular expressions would most likely
164164
lead to the issue described in the first bullet point.

0 commit comments

Comments
 (0)