docs: update .vuepress/config.js (#5043)

## Description ![image](https://user-images.githubusercontent.com/1021101/86193320-7aa13200-bb00-11ea-95ac-aa6468ab7f46.png) ### Next steps: - [x] bump vuepress-theme-cosmos version - [x] tweak config.js - [x] update color variables - [x] sh, shell → bash for syntax highlighting
2026-01-04 04:04:00 +00:00 · 2020-06-30 23:43:35 -07:00
parent 92a361b1e3
commit 5d4eee2eea
17 changed files with 901 additions and 860 deletions
--- a/docs/.vuepress/config.js
+++ b/docs/.vuepress/config.js
@@ -1,6 +1,6 @@
 module.exports = {
  theme: "cosmos",
-  title: "Tendermint",
+  title: "Tendermint Core",
  // locales: {
  //   "/": {
  //     lang: "en-US"
@@ -11,11 +11,30 @@ module.exports = {
  // },
  base: process.env.VUEPRESS_BASE,
  themeConfig: {
+    repo: "tendermint/tendermint",
    docsRepo: "tendermint/tendermint",
-    editLinks: true,
    docsDir: "docs",
-    logo: "/logo.svg",
+    editLinks: true,
    label: "core",
+    sidebar: {
+      auto: true,
+      nav: [
+        {
+          title: "Resources",
+          children: [
+            {
+              title: "Developer Sessions",
+              path: "/DEV_SESSIONS.html"
+            },
+            {
+              title: "RPC",
+              path: "https://docs.tendermint.com/master/rpc/",
+              static: true
+            }
+          ]
+        }
+      ]
+    },
    gutter: {
      title: "Help & Support",
      editLink: true,
@@ -32,7 +51,9 @@ module.exports = {
      }
    },
    footer: {
-      questionsText: "Chat with Cosmos developers in [Discord](https://discordapp.com/channels/669268347736686612) or reach out on the [SDK Developer Forum](https://forum.cosmos.network/c/tendermint) to learn more.",
+      question: {
+        text: "Chat with Tendermint developers in <a href='https://discord.gg/cr7N47p' target='_blank'>Discord</a> or reach out on the <a href='https://forum.cosmos.network/c/tendermint' target='_blank'>Tendermint Forum</a> to learn more."
+      },
      logo: "/logo-bw.svg",
      textLink: {
        text: "tendermint.com",
@@ -72,11 +93,11 @@ module.exports = {
          children: [
            {
              title: "Cosmos SDK",
-              url: "https://cosmos.network/docs"
+              url: "https://docs.cosmos.network"
            },
            {
              title: "Cosmos Hub",
-              url: "https://hub.cosmos.network/"
+              url: "https://hub.cosmos.network"
            }
          ]
        },
@@ -111,23 +132,7 @@ module.exports = {
          ]
        }
      ]
-    },
-    sidebar: [
-      {
-        title: "Resources",
-        children: [
-          {
-            title: "Developer Sessions",
-            path: "/DEV_SESSIONS.html"
-          },
-          {
-            title: "RPC",
-            path: "/master/rpc/",
-            static: true
-          }
-        ]
-      }
-    ]
+    }
  },
  plugins: [
    [
--- a/docs/.vuepress/public/logo.svg
+++ b/docs/.vuepress/public/logo.svg
--- a/docs/.vuepress/styles/index.styl
+++ b/docs/.vuepress/styles/index.styl
@@ -1,3 +1,3 @@
 :root
-  --accent-color #018A01
-  --background #222222
+  --color-link #018A01
+  --color-primary #00BB00
--- a/docs/DOCS_README.md
+++ b/docs/DOCS_README.md
@@ -61,19 +61,19 @@ to send users to the GitHub.

 Make sure you are in the `docs` directory and run the following commands:

-```sh
+```bash
 rm -rf node_modules
 ```

 This command will remove old version of the visual theme and required packages. This step is optional.

-```sh
+```bash
 npm install
 ```

 Install the theme and all dependencies.

-```sh
+```bash
 npm run serve
 ```

--- a/docs/README.md
+++ b/docs/README.md
@@ -1,3 +1,10 @@
+---
+title: Tendermint Core Documentation
+description: Tendermint Core is a blockchain application platform.
+footer:
+  newsletter: false
+---
+
 # Tendermint

 Welcome to the Tendermint Core documentation!
@@ -23,5 +30,4 @@ To find out about the Tendermint ecosystem you can go [here](https://github.com/

 ## Contribute

-To contribute to the documentation, see [this file](https://github.com/tendermint/tendermint/blob/master/docs/DOCS_README.md) for details of the build process and
-considerations when making changes.
+To contribute to the documentation, see [this file](https://github.com/tendermint/tendermint/blob/master/docs/DOCS_README.md) for details of the build process and considerations when making changes.
--- a/docs/app-dev/indexing-transactions.md
+++ b/docs/app-dev/indexing-transactions.md
@@ -79,7 +79,7 @@ The index will be added if the `Index` field of attribute is set to true. In abo

 You can query the transaction results by calling `/tx_search` RPC endpoint:

-```shell
+```bash
 curl "localhost:26657/tx_search?query=\"account.name='igor'\"&prove=true"
 ```

--- a/docs/guides/go-built-in.md
+++ b/docs/guides/go-built-in.md
@@ -38,14 +38,14 @@ Go](https://golang.org/doc/install).

 Verify that you have the latest version of Go installed:

-```sh
+```bash
 $ go version
 go version go1.13.1 darwin/amd64
 ```

 Make sure you have `$GOPATH` environment variable set:

-```sh
+```bash
 $ echo $GOPATH
 /Users/melekes/go
 ```
@@ -54,7 +54,7 @@ $ echo $GOPATH

 We'll start by creating a new Go project.

-```sh
+```bash
 $ mkdir kvstore
 $ cd kvstore
 ```
@@ -75,7 +75,7 @@ func main() {

 When run, this should print "Hello, Tendermint Core" to the standard output.

-```sh
+```bash
 $ go run main.go
 Hello, Tendermint Core
 ```
@@ -568,7 +568,7 @@ os.Exit(0)
 We are going to use [Go modules](https://github.com/golang/go/wiki/Modules) for
 dependency management.

-```sh
+```bash
 $ go mod init github.com/me/example
 $ go build
 ```
@@ -581,7 +581,7 @@ Tendermint Core. Please refer to [the official
 guide](https://docs.tendermint.com/master/introduction/install.html). If you're
 installing from source, don't forget to checkout the latest release (`git checkout vX.Y.Z`).

-```sh
+```bash
 $ rm -rf /tmp/example
 $ TMHOME="/tmp/example" tendermint init

@@ -592,7 +592,7 @@ I[2019-07-16|18:40:36.482] Generated genesis file                       module=m

 We are ready to start our application:

-```sh
+```bash
 $ ./example -config "/tmp/example/config/config.toml"

 badger 2019/07/16 18:42:25 INFO: All 0 tables opened in 0s
@@ -605,7 +605,7 @@ I[2019-07-16|18:42:26.865] Committed state                              module=s

 Now open another tab in your terminal and try sending a transaction:

-```sh
+```bash
 $ curl -s 'localhost:26657/broadcast_tx_commit?tx="tendermint=rocks"'
 {
  "jsonrpc": "2.0",
--- a/docs/guides/go.md
+++ b/docs/guides/go.md
@@ -41,14 +41,14 @@ Go](https://golang.org/doc/install).

 Verify that you have the latest version of Go installed:

-```sh
+```bash
 $ go version
 go version go1.13.1 darwin/amd64
 ```

 Make sure you have `$GOPATH` environment variable set:

-```sh
+```bash
 $ echo $GOPATH
 /Users/melekes/go
 ```
@@ -57,7 +57,7 @@ $ echo $GOPATH

 We'll start by creating a new Go project.

-```sh
+```bash
 $ mkdir kvstore
 $ cd kvstore
 ```
@@ -78,7 +78,7 @@ func main() {

 When run, this should print "Hello, Tendermint Core" to the standard output.

-```sh
+```bash
 $ go run main.go
 Hello, Tendermint Core
 ```
@@ -425,7 +425,7 @@ os.Exit(0)
 We are going to use [Go modules](https://github.com/golang/go/wiki/Modules) for
 dependency management.

-```sh
+```bash
 $ export GO111MODULE=on
 $ go mod init github.com/me/example
 $ go build
@@ -439,7 +439,7 @@ Tendermint Core. Please refer to [the official
 guide](https://docs.tendermint.com/master/introduction/install.html). If you're
 installing from source, don't forget to checkout the latest release (`git checkout vX.Y.Z`).

-```sh
+```bash
 $ rm -rf /tmp/example
 $ TMHOME="/tmp/example" tendermint init

@@ -454,7 +454,7 @@ Feel free to explore the generated files, which can be found at

 We are ready to start our application:

-```sh
+```bash
 $ rm example.sock
 $ ./example

@@ -467,7 +467,7 @@ I[2019-07-16|18:25:11.523] Starting ABCIServer                          impl=ABC
 Then we need to start Tendermint Core and point it to our application. Staying
 within the application directory execute:

-```sh
+```bash
 $ TMHOME="/tmp/example" tendermint node --proxy_app=unix://example.sock

 I[2019-07-16|18:26:20.362] Version info                                 module=main software=0.32.1 block=10 p2p=7
@@ -491,7 +491,7 @@ I[2019-07-16|18:26:20.330] Accepted a new connection

 Now open another tab in your terminal and try sending a transaction:

-```sh
+```bash
 $ curl -s 'localhost:26657/broadcast_tx_commit?tx="tendermint=rocks"'
 {
  "jsonrpc": "2.0",
--- a/docs/guides/java.md
+++ b/docs/guides/java.md
@@ -40,7 +40,7 @@ Please refer to [the Oracle's guide for installing JDK](https://www.oracle.com/t

 Verify that you have installed Java successfully:

-```sh
+```bash
 $ java -version
 java version "12.0.2" 2019-07-16
 Java(TM) SE Runtime Environment (build 12.0.2+10)
@@ -52,7 +52,7 @@ This guide is written using Java SE Development Kit 12.

 Make sure you have `$JAVA_HOME` environment variable set:

-```sh
+```bash
 $ echo $JAVA_HOME
 /Library/Java/JavaVirtualMachines/jdk-12.0.2.jdk/Contents/Home
 ```
@@ -63,7 +63,7 @@ For Gradle installation, please refer to [their official guide](https://gradle.o

 We'll start by creating a new Gradle project.

-```sh
+```bash
 $ export KVSTORE_HOME=~/kvstore
 $ mkdir $KVSTORE_HOME
 $ cd $KVSTORE_HOME
@@ -71,13 +71,13 @@ $ cd $KVSTORE_HOME

 Inside the example directory run:

-```sh
+```bash
 gradle init --dsl groovy --package io.example --project-name example --type java-application --test-framework junit
 ```

 This will create a new project for you. The tree of files should look like:

-```sh
+```bash
 $ tree
 .
 |-- build.gradle
@@ -105,7 +105,7 @@ $ tree

 When run, this should print "Hello world." to the standard output.

-```sh
+```bash
 $ ./gradlew run
 > Task :run
 Hello world.
@@ -166,7 +166,7 @@ Now we should be ready to compile the `*.proto` files.

 Copy the necessary `.proto` files to your project:

-```sh
+```bash
 mkdir -p \
  $KVSTORE_HOME/src/main/proto/github.com/tendermint/tendermint/abci/types \
  $KVSTORE_HOME/src/main/proto/github.com/tendermint/tendermint/crypto/merkle \
@@ -195,13 +195,13 @@ dependencies {

 To generate all protobuf-type classes run:

-```sh
+```bash
 ./gradlew generateProto
 ```

 To verify that everything went smoothly, you can inspect the `build/generated/` directory:

-```sh
+```bash
 $ tree build/generated/
 build/generated/
 |-- source
@@ -534,7 +534,7 @@ To create a default configuration, nodeKey and private validator files, let's
 execute `tendermint init`. But before we do that, we will need to install
 Tendermint Core.

-```sh
+```bash
 $ rm -rf /tmp/example
 $ cd $GOPATH/src/github.com/tendermint/tendermint
 $ make install
@@ -551,7 +551,7 @@ Feel free to explore the generated files, which can be found at

 We are ready to start our application:

-```sh
+```bash
 ./gradlew run

 gRPC server started, listening on 26658
@@ -560,7 +560,7 @@ gRPC server started, listening on 26658
 Then we need to start Tendermint Core and point it to our application. Staying
 within the application directory execute:

-```sh
+```bash
 $ TMHOME="/tmp/example" tendermint node --abci grpc --proxy_app tcp://127.0.0.1:26658

 I[2019-07-28|15:44:53.632] Version info                                 module=main software=0.32.1 block=10 p2p=7
@@ -572,7 +572,7 @@ I[2019-07-28|15:44:54.814] Committed state                              module=s

 Now open another tab in your terminal and try sending a transaction:

-```sh
+```bash
 $ curl -s 'localhost:26657/broadcast_tx_commit?tx="tendermint=rocks"'
 {
  "jsonrpc": "2.0",
@@ -591,7 +591,7 @@ Response should contain the height where this transaction was committed.

 Now let's check if the given key now exists and its value:

-```sh
+```bash
 $ curl -s 'localhost:26657/abci_query?data="tendermint"'
 {
  "jsonrpc": "2.0",
--- a/docs/guides/kotlin.md
+++ b/docs/guides/kotlin.md
@@ -40,7 +40,7 @@ Please refer to [the Oracle's guide for installing JDK](https://www.oracle.com/t

 Verify that you have installed Java successfully:

-```sh
+```bash
 $ java -version
 java version "1.8.0_162"
 Java(TM) SE Runtime Environment (build 1.8.0_162-b12)
@@ -52,7 +52,7 @@ In my case it is Java SE Development Kit 8.

 Make sure you have `$JAVA_HOME` environment variable set:

-```sh
+```bash
 $ echo $JAVA_HOME
 /Library/Java/JavaVirtualMachines/jdk1.8.0_162.jdk/Contents/Home
 ```
@@ -63,7 +63,7 @@ For Gradle installation, please refer to [their official guide](https://gradle.o

 We'll start by creating a new Gradle project.

-```sh
+```bash
 $ export KVSTORE_HOME=~/kvstore
 $ mkdir $KVSTORE_HOME
 $ cd $KVSTORE_HOME
@@ -71,13 +71,13 @@ $ cd $KVSTORE_HOME

 Inside the example directory run:

-```sh
+```bash
 gradle init --dsl groovy --package io.example --project-name example --type kotlin-application
 ```

 This will create a new project for you. The tree of files should look like:

-```sh
+```bash
 $ tree
 .
 |-- build.gradle
@@ -105,7 +105,7 @@ $ tree

 When run, this should print "Hello world." to the standard output.

-```sh
+```bash
 $ ./gradlew run
 > Task :run
 Hello world.
@@ -166,7 +166,7 @@ Now we should be ready to compile the `*.proto` files.

 Copy the necessary `.proto` files to your project:

-```sh
+```bash
 mkdir -p \
  $KVSTORE_HOME/src/main/proto/github.com/tendermint/tendermint/abci/types \
  $KVSTORE_HOME/src/main/proto/github.com/tendermint/tendermint/crypto/merkle \
@@ -195,13 +195,13 @@ dependencies {

 To generate all protobuf-type classes run:

-```sh
+```bash
 ./gradlew generateProto
 ```

 To verify that everything went smoothly, you can inspect the `build/generated/` directory:

-```sh
+```bash
 $ tree build/generated/
 build/generated/
 `-- source
@@ -508,7 +508,7 @@ To create a default configuration, nodeKey and private validator files, let's
 execute `tendermint init`. But before we do that, we will need to install
 Tendermint Core.

-```sh
+```bash
 $ rm -rf /tmp/example
 $ cd $GOPATH/src/github.com/tendermint/tendermint
 $ make install
@@ -525,7 +525,7 @@ Feel free to explore the generated files, which can be found at

 We are ready to start our application:

-```sh
+```bash
 ./gradlew run

 gRPC server started, listening on 26658
@@ -534,7 +534,7 @@ gRPC server started, listening on 26658
 Then we need to start Tendermint Core and point it to our application. Staying
 within the application directory execute:

-```sh
+```bash
 $ TMHOME="/tmp/example" tendermint node --abci grpc --proxy_app tcp://127.0.0.1:26658

 I[2019-07-28|15:44:53.632] Version info                                 module=main software=0.32.1 block=10 p2p=7
@@ -546,7 +546,7 @@ I[2019-07-28|15:44:54.814] Committed state                              module=s

 Now open another tab in your terminal and try sending a transaction:

-```sh
+```bash
 $ curl -s 'localhost:26657/broadcast_tx_commit?tx="tendermint=rocks"'
 {
  "jsonrpc": "2.0",
@@ -565,7 +565,7 @@ Response should contain the height where this transaction was committed.

 Now let's check if the given key now exists and its value:

-```sh
+```bash
 $ curl -s 'localhost:26657/abci_query?data="tendermint"'
 {
  "jsonrpc": "2.0",
--- a/docs/package-lock.json
+++ b/docs/package-lock.json
--- a/docs/package.json
+++ b/docs/package.json
@@ -4,7 +4,7 @@
  "description": "Tendermint Core Documentation",
  "main": "index.js",
  "dependencies": {
-    "vuepress-theme-cosmos": "^1.0.166"
+    "vuepress-theme-cosmos": "^1.0.168"
  },
  "scripts": {
    "preserve": "./pre.sh",
--- a/docs/tendermint-core/light-client-protocol.md
+++ b/docs/tendermint-core/light-client-protocol.md
@@ -38,7 +38,7 @@ https://pkg.go.dev/github.com/tendermint/tendermint/light?tab=doc#TrustOptions
 One way to obtain semi-trusted hash & height is to query multiple full nodes
 and compare their hashes:

-```sh
+```bash
 $ curl -s https://233.123.0.140:26657:26657/commit | jq "{height: .result.signed_header.header.height, hash: .result.signed_header.commit.block_id.hash}"
 {
  "height": "273",
@@ -54,7 +54,7 @@ can be tracked back to a block header by a proof will be verified before
 passing them back to the caller. Other than that, it will present the same
 interface as a full Tendermint node.

-```sh
+```bash
 $ tendermint light supernova -p tcp://233.123.0.140:26657 \
  -w tcp://179.63.29.15:26657,tcp://144.165.223.135:26657 \
  --height=10 --hash=37E9A6DD3FA25E83B22C18835401E8E56088D0D7ABC6FD99FCDC920DD76C1C57
--- a/docs/tendermint-core/running-in-production.md
+++ b/docs/tendermint-core/running-in-production.md
@@ -124,7 +124,7 @@ If, after skimming through the logs, things are not clear still, the next thing
 to try is querying the `/status` RPC endpoint. It provides the necessary info:
 whenever the node is syncing or not, what height it is on, etc.

-```sh
+```bash
 curl http(s)://{ip}:{rpcPort}/status
 ```

@@ -132,7 +132,7 @@ curl http(s)://{ip}:{rpcPort}/status
 state (proposer, latest validators, peers states). From it, you should be able
 to figure out why, for example, the network had halted.

-```sh
+```bash
 curl http(s)://{ip}:{rpcPort}/dump_consensus_state
 ```

--- a/docs/tendermint-core/using-tendermint.md
+++ b/docs/tendermint-core/using-tendermint.md
@@ -106,7 +106,7 @@ definition](https://github.com/tendermint/tendermint/blob/master/types/genesis.g

 To run a Tendermint node, use:

-```sh
+```bash
 tendermint node
 ```

@@ -115,7 +115,7 @@ By default, Tendermint will try to connect to an ABCI application on
 another window. If you don't, kill Tendermint and run an in-process version of
 the `kvstore` app:

-```sh
+```bash
 tendermint node --proxy_app=kvstore
 ```

@@ -129,7 +129,7 @@ in-process with Tendermint if it's written in Go. If your app is not written in
 Go, run it in another process, and use the `--proxy_app` flag to specify the
 address of the socket it is listening on, for instance:

-```sh
+```bash
 tendermint node --proxy_app=/var/run/abci.sock
 ```

--- a/docs/tools/debugging.md
+++ b/docs/tools/debugging.md
@@ -9,7 +9,7 @@ state, the node' status, the WAL, and even the stack trace of the process
 before exit. These files can be useful to examine when debugging a faulty
 Tendermint process.

-```sh
+```bash
 tendermint debug kill <pid> </path/to/out.zip> --home=</path/to/app.d>
 ```

@@ -36,7 +36,7 @@ compressed archives at a regular interval. These archives contain the goroutine
 and heap profiles in addition to the consensus state, network info, node
 status, and even the WAL.

-```sh
+```bash
 tendermint debug dump </path/to/out> --home=</path/to/app.d>
 ```

--- a/scripts/gitian-keys/README.md
+++ b/scripts/gitian-keys/README.md
@@ -12,14 +12,14 @@ Fetch the latest version from the key server to see if any key was revoked in
 the meantime.
 To fetch the latest version of all pgp keys in your gpg homedir,

-```sh
+```bash
 gpg --refresh-keys
 ```

 To fetch keys of Gitian builders and active core developers, feed the list of
 fingerprints of the primary keys into gpg:

-```sh
+```bash
 while read fingerprint keyholder_name; \
 do gpg --keyserver hkp://subset.pool.sks-keyservers.net \
 --recv-keys ${fingerprint}; done < ./keys.txt