Skip to content

Commit a019033

Browse files
committed
doc: unify shell code block formatting
The code blocks aren't displayed correctly in GitBook when using the "shell script" markup hint. We unify all code blocks to use the same "shell" hint. While doing so, we also use an explicit unicode character to represent the shell. This should make it more clear that the character isn't part of the command itself.
1 parent ae63d9d commit a019033

File tree

6 files changed

+80
-79
lines changed

6 files changed

+80
-79
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ Download the latest binaries from the [releases](https://github.com/lightninglab
2020
## Execution
2121
Run Lightning Terminal with a local `lnd` instance:
2222

23-
```
24-
./litd --uipassword=UP48lm4Vjqxy<change_this_or_you_will_get_robbed>
23+
```shell
24+
./litd --uipassword=UP48lm4Vjqxy<change_this_or_you_will_get_robbed>
2525
```
2626

2727
Visit https://localhost:8443 to access Terminal.
@@ -33,8 +33,8 @@ To use LiT with a remote `lnd` instance please [follow these instructions](./doc
3333
## LND
3434
Note that LiT requires `lnd` to be built with **all of its subservers** and requires running at least v0.11.0. Download the latest [official release binary](https://github.com/lightningnetwork/lnd/releases/latest) or build `lnd` from source by following the [installation instructions](https://github.com/lightningnetwork/lnd/blob/master/docs/INSTALL.md). If you choose to build `lnd` from source, use the following command to enable all the relevant subservers:
3535

36-
```
37-
make install tags="signrpc walletrpc chainrpc invoicesrpc"
36+
```shell
37+
make install tags="signrpc walletrpc chainrpc invoicesrpc"
3838
```
3939

4040
## Interaction

doc/config-lnd-integrated.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ To see all available command line options, run `litd --help`.
2626
Here is an example command to start `litd` on testnet with a local `bitcoind`
2727
node:
2828

29-
```shell script
30-
$ litd \
29+
```shell
30+
litd \
3131
--httpslisten=0.0.0.0:8443 \
3232
--uipassword=My$trongP@ssword \
3333
--letsencrypt \
@@ -165,14 +165,14 @@ For `lnd`:
165165

166166
Before:
167167

168-
```shell script
169-
$ lnd --lnddir=~/.lnd --alias=merchant ...
168+
```shell
169+
lnd --lnddir=~/.lnd --alias=merchant ...
170170
```
171171

172172
After:
173173

174-
```shell script
175-
$ litd lnd.lnddir=~/.lnd --lnd.alias=merchant ...
174+
```shell
175+
litd lnd.lnddir=~/.lnd --lnd.alias=merchant ...
176176
```
177177

178178
For `loop`:
@@ -200,14 +200,14 @@ For `loop`:
200200

201201
Before:
202202

203-
```shell script
204-
$ loop --loopoutmaxparts=5 --debuglevel=debug ...
203+
```shell
204+
loop --loopoutmaxparts=5 --debuglevel=debug ...
205205
```
206206

207207
After:
208208

209-
```shell script
210-
$ litd --loop.loopoutmaxparts=5 --loop.debuglevel=debug ...
209+
```shell
210+
litd --loop.loopoutmaxparts=5 --loop.debuglevel=debug ...
211211
```
212212

213213
For `faraday`:
@@ -218,8 +218,8 @@ For `faraday`:
218218

219219
Before: (from command line)
220220

221-
```shell script
222-
$ faraday --min_monitored=48h
221+
```shell
222+
faraday --min_monitored=48h
223223
```
224224

225225
After: (in `lit.conf`)
@@ -234,14 +234,14 @@ For `faraday`:
234234

235235
Before:
236236

237-
```shell script
238-
$ faraday --min_monitored=48h --debuglevel=debug ...
237+
```shell
238+
faraday --min_monitored=48h --debuglevel=debug ...
239239
```
240240

241241
After:
242242

243-
```shell script
244-
$ litd --faraday.min_monitored=48h --faraday.debuglevel=debug...
243+
```shell
244+
litd --faraday.min_monitored=48h --faraday.debuglevel=debug...
245245
```
246246

247247
## Upgrading from LiT v0.1.1-alpha or earlier
@@ -297,8 +297,8 @@ The `lncli` commands in the "integrated" mode are the same as if `lnd` was
297297
running standalone. The `--lnddir` flag does not need to be specified as long
298298
as it is the default directory (`~/.lnd` on Linux).
299299

300-
```shell script
301-
$ lncli --network=testnet getinfo
300+
```shell
301+
lncli --network=testnet getinfo
302302
```
303303

304304
### Example `loop` command
@@ -308,17 +308,17 @@ runs on the same gRPC server as `lnd`. That's why we have to both specify the
308308
`host:port` as well as the TLS certificate of `lnd`. But `loopd` verifies its
309309
own macaroon, so we have to specify that one from the `.loop` directory.
310310

311-
```shell script
312-
$ loop --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert \
311+
```shell
312+
loop --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert \
313313
--macaroonpath=~/.loop/testnet/loop.macaroon \
314314
quote out 500000
315315
```
316316

317317
You can easily create an alias for this by adding the following line to your
318318
`~/.bashrc` file:
319319

320-
```shell script
321-
alias lit-loop="loop --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert --macaroonpath=~/.loop/testnet/loop.macaroon"
320+
```shell
321+
alias lit-loop="loop --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert --macaroonpath=~/.loop/testnet/loop.macaroon"
322322
```
323323

324324
### Example `pool` command
@@ -327,35 +327,35 @@ Again, `poold` also runs on the same gRPC server as `lnd` and we have to specify
327327
the `host:port` and the TLS certificate of `lnd` but use the macaroon from the
328328
`.pool` directory.
329329

330-
```shell script
331-
$ pool --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert \
330+
```shell
331+
pool --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert \
332332
--macaroonpath=~/.pool/testnet/pool.macaroon \
333333
accounts list
334334
```
335335

336336
You can easily create an alias for this by adding the following line to your
337337
`~/.bashrc` file:
338338

339-
```shell script
340-
alias lit-pool="pool --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert --macaroonpath=~/.pool/testnet/pool.macaroon"
339+
```shell
340+
alias lit-pool="pool --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert --macaroonpath=~/.pool/testnet/pool.macaroon"
341341
```
342342

343343
### Example `frcli` command
344344

345345
Faraday's command line tool follows the same pattern as loop. We also have to
346346
specify the server and TLS flags for `lnd` but use `faraday`'s macaroon:
347347

348-
```shell script
349-
$ frcli --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert \
348+
```shell
349+
frcli --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert \
350350
--macaroonpath=~/.faraday/testnet/faraday.macaroon \
351351
audit
352352
```
353353

354354
You can easily create an alias for this by adding the following line to your
355355
`~/.bashrc` file:
356356

357-
```shell script
358-
alias lit-frcli="frcli --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert --macaroonpath=~/.faraday/testnet/faraday.macaroon"
357+
```shell
358+
alias lit-frcli="frcli --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert --macaroonpath=~/.faraday/testnet/faraday.macaroon"
359359
```
360360

361361
## Shutting down LiT

doc/config-lnd-remote.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ By default LiT assumes that `lnd` is running as a standalone process locally. Ho
88
To connect Lightning Terminal to a remote LND instance first make sure your `lnd.conf`
99
file contains the following additional configuration settings:
1010

11-
```
11+
```text
1212
tlsextraip=<externally-reachable-ip-address>
1313
rpclisten=0.0.0.0:10009
1414
```
@@ -36,16 +36,16 @@ depends on your operating system:
3636
Alternatively you can specify a different location by passing `--lit-dir=~/.lit`. After
3737
creating `lit.conf` populate it with the following configuration settings:
3838

39-
```
39+
```text
4040
remote.lnd.rpcserver=<externally-reachable-ip-address>:10009
4141
remote.lnd.macaroondir=/some/folder/with/lnd/data
4242
remote.lnd.tlscertpath=/some/folder/with/lnd/data/tls.cert
4343
```
4444

4545
Run LiT:
4646

47-
```
48-
./litd --uipassword=UP48lm4VjqxmOxB9X9stry6VTKBRQI
47+
```shell
48+
./litd --uipassword=UP48lm4VjqxmOxB9X9stry6VTKBRQI
4949
```
5050

5151
Visit https://localhost:8443 to access LiT.
@@ -75,8 +75,8 @@ To see all available command line options, run `litd --help`.
7575
The most minimal example command to start `litd` and connect it to a local `lnd`
7676
node that is running with default configuration settings is:
7777

78-
```shell script
79-
$ litd --uipassword=My$trongP@ssword
78+
```shell
79+
litd --uipassword=My$trongP@ssword
8080
```
8181

8282
All other command line flags are only needed to overwrite the default behavior.
@@ -85,8 +85,8 @@ Here is an example command to start `litd` connected to a testnet `lnd` that is
8585
running on another host and overwrites a few default settings in `loop`, `pool`,
8686
and `faraday` (optional):
8787

88-
```shell script
89-
$ litd \
88+
```shell
89+
litd \
9090
--httpslisten=0.0.0.0:8443 \
9191
--uipassword=My$trongP@ssword \
9292
--letsencrypt \
@@ -213,8 +213,8 @@ implied by looking inside the default directories for that network. Or you speci
213213
The `lncli` commands in the "remote" mode are the same as if `lnd` was running standalone
214214
on a remote host. We need to specify all flags explicitly.
215215

216-
```shell script
217-
$ lncli --rpcserver=some-other-host:10009 \
216+
```shell
217+
lncli --rpcserver=some-other-host:10009 \
218218
--tlscertpath=/some/folder/with/lnd/data/tls.cert \
219219
--macaroonpath=/some/folder/with/lnd/data/admin.macaroon \
220220
getinfo
@@ -227,17 +227,17 @@ the same port as the UI server. That's why we have to both specify the `host:por
227227
as the TLS certificate of LiT. But `loopd` verifies its own macaroon, so we have to
228228
specify that one from the `.loop` directory.
229229

230-
```shell script
231-
$ loop --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert \
230+
```shell
231+
loop --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert \
232232
--macaroonpath=~/.loop/testnet/loop.macaroon \
233233
quote out 500000
234234
```
235235

236236
You can easily create an alias for this by adding the following line to your `~/.bashrc`
237237
file:
238238

239-
```shell script
240-
alias lit-loop="loop --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.loop/testnet/loop.macaroon"
239+
```shell
240+
alias lit-loop="loop --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.loop/testnet/loop.macaroon"
241241
```
242242

243243
### Example `pool` command
@@ -246,35 +246,35 @@ Again, `poold` also runs on the same port as the UI server and we have to
246246
specify the `host:port` and the TLS certificate of LiT but use the macaroon from
247247
the `.pool` directory.
248248

249-
```shell script
250-
$ pool --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert \
249+
```shell
250+
pool --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert \
251251
--macaroonpath=~/.pool/testnet/pool.macaroon \
252252
accounts list
253253
```
254254

255255
You can easily create an alias for this by adding the following line to your
256256
`~/.bashrc` file:
257257

258-
```shell script
259-
alias lit-pool="pool --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.pool/testnet/pool.macaroon"
258+
```shell
259+
alias lit-pool="pool --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.pool/testnet/pool.macaroon"
260260
```
261261

262262
### Example `frcli` command
263263

264264
Faraday's command line tool follows the same pattern as loop. We also have to specify the
265265
server and TLS flags for `lnd` but use `faraday`'s macaroon:
266266

267-
```shell script
268-
$ frcli --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert \
267+
```shell
268+
frcli --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert \
269269
--macaroonpath=~/.faraday/testnet/faraday.macaroon \
270270
audit
271271
```
272272

273273
You can easily create an alias for this by adding the following line to your `~/.bashrc`
274274
file:
275275

276-
```shell script
277-
alias lit-frcli="frcli --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.faraday/testnet/faraday.macaroon"
276+
```shell
277+
alias lit-frcli="frcli --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.faraday/testnet/faraday.macaroon"
278278
```
279279

280280
## Shutting down LiT

0 commit comments

Comments
 (0)