Skip to content

Commit d046e98

Browse files
ccoVeilleMitMaro
authored andcommitted
chore: add identifier to fenced block
1 parent b5b7dc6 commit d046e98

File tree

3 files changed

+92
-38
lines changed

3 files changed

+92
-38
lines changed

README.md

Lines changed: 41 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -125,19 +125,25 @@ exec script.sh "exec" "command" "new-command"
125125

126126
### Most systems
127127

128-
git config --global sequence.editor interactive-rebase-tool
128+
```shell
129+
git config --global sequence.editor interactive-rebase-tool
130+
```
129131

130132
### Windows
131133

132134
#### Standard Command Prompt and Windows Terminal
133135

134-
git config --global sequence.editor "'C:/path/to/interactive-rebase-tool.exe'"
136+
```shell
137+
git config --global sequence.editor "'C:/path/to/interactive-rebase-tool.exe'"
138+
```
135139

136140
#### GitBash
137141

138142
GitBash requires the use of `winpty` in order to work correctly, so to set the editor use:
139143

140-
git config --global sequence.editor "winpty /c/path/to/interactive-rebase-tool.exe"
144+
```shell
145+
git config --global sequence.editor "winpty /c/path/to/interactive-rebase-tool.exe"
146+
```
141147

142148
#### Notes
143149

@@ -147,7 +153,9 @@ Windows before version 10 has [serious rendering issues with saturated darker co
147153

148154
You can temporarily use a different sequence editor by using the `GIT_SEQUENCE_EDITOR` environment variable:
149155

150-
GIT_SEQUENCE_EDITOR=emacs git rebase -i [<upstream> [<branch>]]
156+
```shell
157+
GIT_SEQUENCE_EDITOR=emacs git rebase -i [<upstream> [<branch>]]
158+
```
151159
152160
## Direct Usage
153161
@@ -245,56 +253,72 @@ To start developing the project, you will need to [install Rust][install-rust],
245253
246254
This project uses [cargo-make](https://github.com/sagiegurari/cargo-make) as a task runner. To install:
247255
248-
cargo install --force cargo-make
256+
```shell
257+
cargo install --force cargo-make
258+
```
249259
250260
#### Debian and derivatives
251261
252262
If you plan to build a release package you will need `pkg-config` and `liblzma-dev`. They can be installed using `apt`:
253263
254-
sudo apt install pkg-config liblzma-dev
264+
```shell
265+
sudo apt install pkg-config liblzma-dev
266+
```
255267
256268
### Build and run
257269
258270
To build or run the project, from the project root run:
259271
260-
# only build
261-
cargo make build --release
262-
# build and run
263-
cargo run -- <path-to-git-rebase-todo-file>
272+
```shell
273+
# only build
274+
cargo make build --release
275+
# build and run
276+
cargo run -- <path-to-git-rebase-todo-file>
277+
```
264278
265279
Sample rebase todo files can be found in ./test/fixtures.
266280
267281
### Tests
268282
269283
Automated tests are available for all features and can be run with:
270284
271-
cargo make test
285+
```shell
286+
cargo make test
287+
```
272288
273289
### Docs
274290
275291
API docs for the project are generated using Rust Doc:
276292
277-
cargo make docs
293+
```shell
294+
cargo make docs
295+
```
278296
279297
### Linting
280298
281-
An addition to the lints provided by rustc, this project uses Clippy to provide additional linting, run with:
299+
An addition to the lints provided by `rustc`, this project uses `Clippy` to provide additional linting, run with:
282300
283-
cargo make lint
301+
```shell
302+
cargo make lint
303+
```
284304
285305
This will run lints using stable and nightly. The nightly lints may show errors, but will not result in a failure.
286306
287307
### Format
288308
289-
This project uses rust-fmt to provide a consistent format. A helpful script will ensure that all files are formatted correctly:
309+
This project uses `rust-fmt` to provide a consistent format. A helpful script will ensure that all files are formatted correctly:
290310
291-
cargo make format
311+
```shell
312+
cargo make format
313+
```
292314
293315
### Coverage
294316
295317
The project use [Tarpaulin](https://github.com/xd009642/tarpaulin) to generate coverage reports. Coverage reports are used to find gaps in tests. To generate the coverage report:
296318
297-
cargo make coverage
319+
```shell
320+
cargo make coverage
321+
```
298322
299323
An addition to the report printed to the CLI, an HTML report can be found in the `coverage` directory.
300324

readme/customization.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ The tool can be customized using the [git config](https://git-scm.com/docs/git-c
1515

1616
### Example
1717

18-
git config --global interactive-rebase-tool.foregroundColor black
18+
```shell
19+
git config --global interactive-rebase-tool.foregroundColor black
20+
```
1921

2022
## Git Configuration
2123

@@ -149,10 +151,12 @@ Most keys can be changed to any printable character or supported special charact
149151

150152
### Example
151153

152-
# single value
153-
git config --global interactive-rebase-tool.inputRebase S
154-
# multiple values
155-
git config --global interactive-rebase-tool.inputRebase "S L K"
154+
```shell
155+
# single value
156+
git config --global interactive-rebase-tool.inputRebase S
157+
# multiple values
158+
git config --global interactive-rebase-tool.inputRebase "S L K"
159+
```
156160

157161
### Supported Special Keys
158162

readme/install.md

Lines changed: 42 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -22,23 +22,29 @@
2222

2323
Download the `.deb` file from the [releases page][releases] and install with:
2424

25-
sudo dpkg -i /path/to/git-interactive-rebase-tool-*.deb
25+
```shell
26+
sudo dpkg -i /path/to/git-interactive-rebase-tool-*.deb
27+
```
2628

2729
The executable will be installed to `/usr/bin`.
2830

2931
### Red Hat Linux, Fedora and derivatives
3032

3133
Download the `.rpm` file from the [releases page][releases] and install with your package manager of choice:
3234

33-
sudo rpm -i /path/to/git-interactive-rebase-tool-*.rpm
34-
sudo yum localinstall /path/to/git-interactive-rebase-tool-*.rpm
35-
sudo dnf localinstall /path/to/git-interactive-rebase-tool-*.rpm
35+
```shell
36+
sudo rpm -i /path/to/git-interactive-rebase-tool-*.rpm
37+
sudo yum localinstall /path/to/git-interactive-rebase-tool-*.rpm
38+
sudo dnf localinstall /path/to/git-interactive-rebase-tool-*.rpm
39+
```
3640

3741
### macOS
3842

3943
#### With [Homebrew](https://brew.sh/)
4044

41-
brew install git-interactive-rebase-tool
45+
```shell
46+
brew install git-interactive-rebase-tool
47+
```
4248

4349
#### Manual install
4450

@@ -65,7 +71,9 @@ Download the binary from the [releases page][releases] and copy it as `interacti
6571

6672
The project can be installed directly from [crates.io](https://crates.io/crates/git-interactive-rebase-tool) via cargo.
6773

68-
cargo install git-interactive-rebase-tool
74+
```shell
75+
cargo install git-interactive-rebase-tool
76+
```
6977

7078
## Community Supported Repositories
7179

@@ -75,52 +83,70 @@ Community supported repositories are not officially supported, as they are maint
7583

7684
Install the [git-interactive-rebase-tool](https://pkgs.alpinelinux.org/packages?name=git-interactive-rebase-tool) package from the community repository (since Alpine v3.14):
7785

78-
apk add git-interactive-rebase-tool
86+
```shell
87+
apk add git-interactive-rebase-tool
88+
```
7989

8090
### Arch Linux
8191

8292
With your [AUR](https://aur.archlinux.org/) helper of choice:
8393

84-
yay -S git-interactive-rebase-tool
94+
```shell
95+
yay -S git-interactive-rebase-tool
96+
```
8597

8698
#### Manual Install
8799

88100
1. Download the [package snapshot](https://aur.archlinux.org/packages/git-interactive-rebase-tool/)
89101
2. Extract to a known location
90102
3. Run `makepkg -si` from the extracted location
91103

92-
### Gnu Guix Package Manager
104+
### GNU Guix Package Manager
93105

94-
guix install git-interactive-rebase-tool
106+
```shell
107+
guix install git-interactive-rebase-tool
108+
```
95109

96110
#### In a temporary environment
97111

98-
guix shell git-interactive-rebase-tool
112+
```shell
113+
guix shell git-interactive-rebase-tool
114+
```
99115

100116
#### In a temporary container (Linux namespace)
101117

102-
guix shell --container git-interactive-rebase-tool
118+
```shell
119+
guix shell --container git-interactive-rebase-tool
120+
```
103121

104122
### FreeBSD
105123

106124
FreeBSD support is provided by the community, and while attempts are made to ensure everything works on the platform, it is not officially supported. If you run into problems please [create an issue](https://github.com/MitMaro/git-interactive-rebase-tool/issues/new) describing the problem.
107125

108126
With [Ports](https://www.freebsd.org/ports/) using `pkg`
109127

110-
pkg install interactive_rebase_tool
128+
```shell
129+
pkg install interactive_rebase_tool
130+
```
111131

112132
#### Manual
113133

114-
cd /usr/ports/devel/interactive_rebase_tool && make install clean
134+
```shell
135+
cd /usr/ports/devel/interactive_rebase_tool && make install clean
136+
```
115137

116138
### Windows
117139

118140
#### With [Chocolatey](https://chocolatey.org/)
119141

120-
choco install git-interactive-rebase-tool
142+
```shell
143+
choco install git-interactive-rebase-tool
144+
```
121145

122146
#### With [Scoop](https://scoop.sh/)
123147

124-
scoop install git-interactive-rebase-tool
148+
```shell
149+
scoop install git-interactive-rebase-tool
150+
```
125151

126152
[releases]:https://github.com/MitMaro/git-interactive-rebase-tool/releases

0 commit comments

Comments
 (0)