Skip to content

Commit f55602f

Browse files
committed
docs: linting
1 parent ccd0349 commit f55602f

2 files changed

Lines changed: 16 additions & 7 deletions

File tree

.harper-dictionary.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
fixup
2+
fixups
3+
permalink
4+
renamings
5+
unshallow
6+
unstaged

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Bundle of commands focused on swift and streamlined git operations.
66

77
## Feature overview
88

9+
<!-- rumdl-disable MD033 -->
910
<table>
1011
<tr>
1112
<th>Interactive staging</th>
@@ -24,6 +25,7 @@ Bundle of commands focused on swift and streamlined git operations.
2425
<td></td>
2526
</tr>
2627
</table>
28+
<!-- rumdl-enable MD033 -->
2729

2830
- **Interactive staging** of hunks (parts of a file). Displays hunk diffs with
2931
syntax highlighting, and allows resetting or navigating to the hunk.
@@ -70,7 +72,7 @@ Bundle of commands focused on swift and streamlined git operations.
7072
<!-- tocstop -->
7173

7274
## Installation
73-
**Requirements**
75+
**Requirements** <!-- rumdl-disable-line MD036 -->
7476
- nvim 0.10+
7577
- A plugin implementing `vim.ui.select`, such as:
7678
- [snacks.picker](http://github.com/folke/snacks.nvim)
@@ -263,8 +265,7 @@ require("tinygit").interactiveStaging()
263265
require("tinygit").smartCommit { pushIfClean = false, pullBeforePush = true }
264266
```
265267

266-
**Example workflow**
267-
Assuming these keybindings:
268+
**Example workflow**, assuming these keybindings:
268269

269270
```lua
270271
vim.keymap.set(
@@ -297,7 +298,8 @@ combine staging, committing, and pushing into a single step, when it is the last
297298
commit you intend to make.
298299

299300
### Amend and fixup commits
300-
**Amending**
301+
302+
#### Amending
301303
- `amendOnlyMsg` just opens the commit popup to change the last commit message,
302304
and does not stage any changes.
303305
- `amendNoEdit` keeps the last commit message; if there are no staged changes,
@@ -314,7 +316,7 @@ require("tinygit").amendNoEdit {
314316
}
315317
```
316318

317-
**Fixup commits**
319+
#### Fixup commits
318320
- `fixupCommit` lets you select a commit from the last X commits and runs `git
319321
commit --fixup` on the selected commit.
320322
- If there are no staged changes, stages all changes (`git add --all`), like
@@ -343,7 +345,8 @@ require("tinygit").undoLastCommitOrAmend()
343345
undone.
344346

345347
### GitHub interaction
346-
**Search issues & PRs**
348+
349+
#### Search issues & PRs
347350
- All GitHub interaction commands require `curl`.
348351

349352
```lua
@@ -356,7 +359,7 @@ require("tinygit").issuesAndPrs { type = "all", state = "all" }
356359
require("tinygit").openIssueUnderCursor()
357360
```
358361

359-
**GitHub URL**
362+
#### GitHub URL
360363
Creates a permalink to the current file/lines at GitHub. The link is opened in
361364
the browser and copied to the system clipboard. In normal mode, uses the current
362365
file, in visual mode, uses the selected lines. (Note that visual mode detection

0 commit comments

Comments
 (0)