Markdown linter (#5494)

* linter * Add markdown linter * add env * only check markdown * Add token * Update .github/workflows/test-suite.yml * Markdown linter * Exit code * Update script * rename * mdlint * Add an empty line after end of file * Testing disable * add text * update mdlint.sh * ori validator inclusion * Add config yml file * Remove MD041 and fix advanced-datadir file * FIx validator inclusion file conflict * Merge branch 'unstable' into markdown-linter * change files * Merge branch 'markdown-linter' of https://github.com/chong-he/lighthouse into markdown-linter * mdlint * Remove MD025 * Remove MD036 * Remove MD045 * Removr MD001 * Set MD028 to false * Remove MD024 * Remove MD055 * Remove MD029 * Remove MD040 * Set MD040 to false * Set MD033 to false * Set MD013 to false * Rearrange yml file * Update mdlint.sh and test * Test remove fix * Test with fix * Test with space * Fix summary indentation * Test mdlint.sh * Update mdlint.sh * Test * Update * Test fix * Test again * Fix * merge into check-code * Update scripts/mdlint.sh Co-authored-by: Mac L <mjladson@pm.me> * Update scripts/mdlint.sh Co-authored-by: Mac L <mjladson@pm.me> * Remove set -e * Add comment * Merge pull request #7 from chong-he/unstable Merge unstable to markdown branch * mdlint * Merge branch 'unstable' into markdown-linter * mdlint
2026-04-30 03:03:45 +00:00 · 2024-05-24 10:45:19 +08:00
parent 7073242ccc
commit 3070cb7c39
68 changed files with 720 additions and 637 deletions
--- a/book/src/SUMMARY.md
+++ b/book/src/SUMMARY.md
@@ -2,66 +2,66 @@

 * [Introduction](./intro.md)
 * [Installation](./installation.md)
-    * [Pre-Built Binaries](./installation-binaries.md)
-    * [Docker](./docker.md)
-    * [Build from Source](./installation-source.md)
-    * [Raspberry Pi 4](./pi.md)
-    * [Cross-Compiling](./cross-compiling.md)
-    * [Homebrew](./homebrew.md)
-    * [Update Priorities](./installation-priorities.md)
+  * [Pre-Built Binaries](./installation-binaries.md)
+  * [Docker](./docker.md)
+  * [Build from Source](./installation-source.md)
+  * [Raspberry Pi 4](./pi.md)
+  * [Cross-Compiling](./cross-compiling.md)
+  * [Homebrew](./homebrew.md)
+  * [Update Priorities](./installation-priorities.md)
 * [Run a Node](./run_a_node.md)
 * [Become a Validator](./mainnet-validator.md)
 * [Validator Management](./validator-management.md)
-    * [The `validator-manager` Command](./validator-manager.md)
-        * [Creating validators](./validator-manager-create.md)
-        * [Moving validators](./validator-manager-move.md)
-    * [Slashing Protection](./slashing-protection.md)
-    * [Voluntary Exits](./voluntary-exit.md)
-    * [Partial Withdrawals](./partial-withdrawal.md)
-    * [Validator Monitoring](./validator-monitoring.md)
-    * [Doppelganger Protection](./validator-doppelganger.md)
-    * [Suggested Fee Recipient](./suggested-fee-recipient.md)
-    * [Validator Graffiti](./graffiti.md)
+  * [The `validator-manager` Command](./validator-manager.md)
+    * [Creating validators](./validator-manager-create.md)
+    * [Moving validators](./validator-manager-move.md)
+  * [Slashing Protection](./slashing-protection.md)
+  * [Voluntary Exits](./voluntary-exit.md)
+  * [Partial Withdrawals](./partial-withdrawal.md)
+  * [Validator Monitoring](./validator-monitoring.md)
+  * [Doppelganger Protection](./validator-doppelganger.md)
+  * [Suggested Fee Recipient](./suggested-fee-recipient.md)
+  * [Validator Graffiti](./graffiti.md)
 * [APIs](./api.md)
-    * [Beacon Node API](./api-bn.md)
-        * [Lighthouse API](./api-lighthouse.md)
-        * [Validator Inclusion APIs](./validator-inclusion.md)
-    * [Validator Client API](./api-vc.md)
-        * [Endpoints](./api-vc-endpoints.md)
-        * [Authorization Header](./api-vc-auth-header.md)
-        * [Signature Header](./api-vc-sig-header.md)
-    * [Prometheus Metrics](./advanced_metrics.md)
+  * [Beacon Node API](./api-bn.md)
+    * [Lighthouse API](./api-lighthouse.md)
+    * [Validator Inclusion APIs](./validator-inclusion.md)
+  * [Validator Client API](./api-vc.md)
+    * [Endpoints](./api-vc-endpoints.md)
+    * [Authorization Header](./api-vc-auth-header.md)
+    * [Signature Header](./api-vc-sig-header.md)
+  * [Prometheus Metrics](./advanced_metrics.md)
 * [Lighthouse UI (Siren)](./lighthouse-ui.md)
-	* [Installation](./ui-installation.md)
-    * [Authentication](./ui-authentication.md)
-	* [Configuration](./ui-configuration.md)
-	* [Usage](./ui-usage.md)
-	* [FAQs](./ui-faqs.md)
+  * [Installation](./ui-installation.md)
+  * [Authentication](./ui-authentication.md)
+  * [Configuration](./ui-configuration.md)
+  * [Usage](./ui-usage.md)
+  * [FAQs](./ui-faqs.md)
 * [Advanced Usage](./advanced.md)
-    * [Checkpoint Sync](./checkpoint-sync.md)
-    * [Custom Data Directories](./advanced-datadir.md)
-    * [Proposer Only Beacon Nodes](./advanced-proposer-only.md)
-    * [Remote Signing with Web3Signer](./validator-web3signer.md)
-    * [Database Configuration](./advanced_database.md)
-    * [Database Migrations](./database-migrations.md)
-    * [Key Management (Deprecated)](./key-management.md)
-    * [Key Recovery](./key-recovery.md)
-    * [Advanced Networking](./advanced_networking.md)
-    * [Running a Slasher](./slasher.md)
-    * [Redundancy](./redundancy.md)
-    * [Release Candidates](./advanced-release-candidates.md)
-    * [MEV](./builders.md)
-    * [Merge Migration](./merge-migration.md)
-    * [Late Block Re-orgs](./late-block-re-orgs.md)
-    * [Blobs](./advanced-blobs.md)
+  * [Checkpoint Sync](./checkpoint-sync.md)
+  * [Custom Data Directories](./advanced-datadir.md)
+  * [Proposer Only Beacon Nodes](./advanced-proposer-only.md)
+  * [Remote Signing with Web3Signer](./validator-web3signer.md)
+  * [Database Configuration](./advanced_database.md)
+  * [Database Migrations](./database-migrations.md)
+  * [Key Management (Deprecated)](./key-management.md)
+  * [Key Recovery](./key-recovery.md)
+  * [Advanced Networking](./advanced_networking.md)
+  * [Running a Slasher](./slasher.md)
+  * [Redundancy](./redundancy.md)
+  * [Release Candidates](./advanced-release-candidates.md)
+  * [MEV](./builders.md)
+  * [Merge Migration](./merge-migration.md)
+  * [Late Block Re-orgs](./late-block-re-orgs.md)
+  * [Blobs](./advanced-blobs.md)
 * [Built-In Documentation](./help_general.md)
-    * [Beacon Node](./help_bn.md)
-    * [Validator Client](./help_vc.md)
-    * [Validator Manager](./help_vm.md)
-        * [Create](./help_vm_create.md)
-        * [Import](./help_vm_import.md)
-        * [Move](./help_vm_move.md)  
+  * [Beacon Node](./help_bn.md)
+  * [Validator Client](./help_vc.md)
+  * [Validator Manager](./help_vm.md)
+    * [Create](./help_vm_create.md)
+    * [Import](./help_vm_import.md)
+    * [Move](./help_vm_move.md)  
 * [Contributing](./contributing.md)
-    * [Development Environment](./setup.md)
+  * [Development Environment](./setup.md)
 * [FAQs](./faq.md)
-* [Protocol Developers](./developers.md)
+* [Protocol Developers](./developers.md)