Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Built-in documentation text width in Lighthouse book #5394

Merged
merged 3 commits into from
Mar 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion book/src/help_bn.md
Original file line number Diff line number Diff line change
Expand Up @@ -509,4 +509,5 @@ OPTIONS:
Specify a weak subjectivity checkpoint in `block_root:epoch` format to verify the node's sync against. The
block root should be 0x-prefixed. Note that this flag is for verification only, to perform a checkpoint sync
from a recent state use --checkpoint-sync-url.
```
```
<style> .content main {max-width:88%;} </style>
3 changes: 2 additions & 1 deletion book/src/help_general.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,4 +104,5 @@ SUBCOMMANDS:
blocks and attestations). [aliases: v, vc, validator]
validator_manager Utilities for managing a Lighthouse validator client via the HTTP API. [aliases: vm,
validator-manager, validator_manager]
```
```
<style> .content main {max-width:88%;} </style>
3 changes: 2 additions & 1 deletion book/src/help_vc.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,4 +222,5 @@ OPTIONS:

--web3-signer-max-idle-connections <COUNT>
Maximum number of idle connections to maintain per web3signer host. Default is unlimited.
```
```
<style> .content main {max-width:88%;} </style>
3 changes: 2 additions & 1 deletion book/src/help_vm.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,5 @@ SUBCOMMANDS:
move Uploads validators to a validator client using the HTTP API. The validators are defined in a JSON file
which can be generated using the "create-validators" command. This command only supports validators
signing via a keystore on the local file system (i.e., not Web3Signer validators).
```
```
<style> .content main {max-width:88%;} </style>
3 changes: 2 additions & 1 deletion book/src/help_vm_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,4 +134,5 @@ OPTIONS:
-t, --testnet-dir <DIR>
Path to directory containing eth2_testnet specs. Defaults to a hard-coded Lighthouse testnet. Only effective
if there is no existing database.
```
```
<style> .content main {max-width:88%;} </style>
3 changes: 2 additions & 1 deletion book/src/help_vm_import.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,4 +98,5 @@ OPTIONS:
--vc-url <HTTP_ADDRESS>
A HTTP(S) address of a validator client using the keymanager-API. If this value is not supplied then a 'dry
run' will be conducted where no changes are made to the validator client. [default: http://localhost:5062]
```
```
<style> .content main {max-width:88%;} </style>
3 changes: 2 additions & 1 deletion book/src/help_vm_move.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,4 +115,5 @@ OPTIONS:
if there is no existing database.
--validators <STRING>
The validators to be moved. Either a list of 0x-prefixed validator pubkeys or the keyword "all".
```
```
<style> .content main {max-width:88%;} </style>
3 changes: 3 additions & 0 deletions scripts/cli.sh
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ write_to_file() {

# We need to add the header and the backticks to create the code block.
printf "# %s\n\n\`\`\`\n%s\n\`\`\`" "$program" "$cmd" > "$file"

# Adjust the width of the help text and append to the end of file
sed -i -e '$a\'$'\n''<style> .content main {max-width:88%;} </style>' "$file"
}

CMD=./target/release/lighthouse
Expand Down