Skip to content

Commit c663dc1

Browse files
authored
README tweak: decrease level of headers (#337)
1 parent d7f88d7 commit c663dc1

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
This tool is designed to help you use git more efficiently.
2828
It's **lightweight** and **easy to use**.
2929

30-
### 📥 Installation
30+
# 📥 Installation
3131

3232
*Make sure you have [`fzf`](https://github.com/junegunn/fzf) installed.*
3333

@@ -60,19 +60,19 @@ brew install forgit
6060
# Clone the repository and source it in your shell's rc file or put bin/git-forgit into your $PATH
6161
```
6262

63-
### Fig
63+
# Fig
6464

6565
[Fig](https://fig.io) adds apps, shortcuts, and autocomplete to your existing terminal.
6666

6767
Install `forgit` in just one click.
6868

6969
[![Install with Fig](https://fig.io/badges/install-with-fig.svg)](https://fig.io/plugins/other/forgit)
7070

71-
### Arch User Repository
71+
# Arch User Repository
7272

7373
[AUR](https://wiki.archlinux.org/title/Arch_User_Repository) packages, maintained by the developers of forgit, are available. Install the [forgit](https://aur.archlinux.org/packages/forgit) package for the latest release or [forgit-git](https://aur.archlinux.org/packages/forgit-git) to stay up to date with the latest commits from the master branch of this repository.
7474

75-
### 📝 Features
75+
# 📝 Features
7676

7777
- **Interactive `git add` selector** (`ga`)
7878

@@ -118,7 +118,7 @@ Install `forgit` in just one click.
118118

119119
- **Interactive `git commit --fixup && git rebase -i --autosquash` selector** (`gfu`)
120120

121-
### ⌨ Keybinds
121+
# ⌨ Keybinds
122122

123123
| Key | Action |
124124
| :-------------------------------------------: | ------------------------------------------- |
@@ -139,7 +139,7 @@ Install `forgit` in just one click.
139139
\* Available when the selection contains a commit hash or a stash ID.
140140
For linux users `FORGIT_COPY_CMD` should be set to make copy work. Example: `FORGIT_COPY_CMD='xclip -selection clipboard'`.
141141

142-
### ⚙ Options
142+
# ⚙ Options
143143

144144
Options can be set via environment variables. They have to be **exported** in
145145
order to be recognized by `forgit`.
@@ -150,7 +150,7 @@ For instance, if you want to order branches in `gcb` by the last committed date
150150
export FORGIT_CHECKOUT_BRANCH_BRANCH_GIT_OPTS='--sort=-committerdate'
151151
```
152152

153-
#### shell aliases
153+
## shell aliases
154154

155155
You can change the default aliases by defining these variables below.
156156
(To disable all aliases, Set the `FORGIT_NO_ALIASES` flag.)
@@ -176,7 +176,7 @@ forgit_blame=gbl
176176
forgit_fixup=gfu
177177
```
178178

179-
#### git integration
179+
## git integration
180180

181181
You can use forgit as a subcommand of git by making `git-forgit` available in `$PATH`:
182182

@@ -207,7 +207,7 @@ And use forgit functions via a git alias:
207207
git cf
208208
```
209209

210-
#### git options
210+
## git options
211211

212212
If you want to customize `git`'s behavior within forgit there is a dedicated variable for each forgit command.
213213
These are passed to the according `git` calls.
@@ -232,7 +232,7 @@ These are passed to the according `git` calls.
232232
| `gfu` | `FORGIT_FIXUP_GIT_OPTS` |
233233
| `gcp` | `FORGIT_CHERRY_PICK_GIT_OPTS` |
234234

235-
#### pagers
235+
## pagers
236236

237237
Forgit will use the default configured pager from git (`core.pager`,
238238
`pager.show`, `pager.diff`) but can be altered with the following environment
@@ -247,7 +247,7 @@ variables:
247247
| pager on `gitignore` | `FORGIT_IGNORE_PAGER` | `bat -l gitignore --color always` _or_ `cat` |
248248
| git log format | `FORGIT_GLO_FORMAT` | `%C(auto)%h%d %s %C(black)%C(bold)%cr%reset` |
249249

250-
#### fzf options
250+
## fzf options
251251

252252
You can add default fzf options for `forgit`, including keybinds, layout, etc.
253253
(No need to repeat the options already defined in `FZF_DEFAULT_OPTS`)
@@ -309,42 +309,42 @@ export FORGIT_LOG_FZF_OPTS='
309309
'
310310
```
311311

312-
#### other options
312+
## other options
313313

314314
| Option | Description | Default |
315315
|-----------------------------|------------------------------------------|-----------------------------------------------|
316316
| `FORGIT_LOG_FORMAT` | git log format | `%C(auto)%h%d %s %C(black)%C(bold)%cr%Creset` |
317317
| `FORGIT_PREVIEW_CONTEXT` | lines of diff context in preview mode | 3 |
318318
| `FORGIT_FULLSCREEN_CONTEXT` | lines of diff context in fullscreen mode | 10 |
319319

320-
### 📦 Optional dependencies
320+
# 📦 Optional dependencies
321321

322322
- [`delta`](https://github.com/dandavison/delta) / [`diff-so-fancy`](https://github.com/so-fancy/diff-so-fancy): For better human readable diffs.
323323

324324
- [`bat`](https://github.com/sharkdp/bat.git): Syntax highlighting for `gitignore`.
325325

326326
- [`emoji-cli`](https://github.com/wfxr/emoji-cli): Emoji support for `git log`.
327327

328-
### Completions
328+
# Completions
329329

330-
#### Bash
330+
## Bash
331331

332332
- Put [`completions/git-forgit.bash`](https://github.com/wfxr/forgit/blob/master/completions/git-forgit.bash) in
333333
`~/.local/share/bash-completion/completions` to have bash tab completion for `git forgit` and configured git aliases.
334334
- Source [`completions/git-forgit.bash`](https://github.com/wfxr/forgit/blob/master/completions/git-forgit.bash) explicitly to have
335335
bash tab completion for forgit shell functions and aliases (e.g. `gcb <tab>` completes branches).
336336

337-
#### Zsh
337+
## Zsh
338338

339339
- Put [`completions/_git-forgit`](completions/_git-forgit) in a directory in your `$fpath` (e.g. `/usr/share/zsh/site-functions`) to have zsh tab completion for `git forgit` and configured git aliases.
340340
- Source [`completions/git-forgit.zsh`](completions/git-forgit.zsh) to have zsh tab completion for forgit shell functions and aliases (e.g. `gcb <tab>` completes branches).
341341

342-
### 💡 Tips
342+
# 💡 Tips
343343

344344
- Most of the commands accept optional arguments (eg, `glo develop`, `glo f738479..188a849b -- main.go`, `gco master`).
345345
- `gd` supports specifying revision(eg, `gd HEAD~`, `gd v1.0 README.md`).
346346
- Call `gi` with arguments to get the wanted `.gitignore` contents directly(eg, `gi cmake c++`).
347347

348-
### 📃 License
348+
# 📃 License
349349

350350
[MIT](https://wfxr.mit-license.org/2017) (c) Wenxuan Zhang

0 commit comments

Comments
 (0)