Skip to content

Commit

Permalink
docs: update .vuepress/config.js (#5043)
Browse files Browse the repository at this point in the history
## 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
  • Loading branch information
lovincyrus authored Jul 1, 2020
1 parent 92a361b commit 5d4eee2
Show file tree
Hide file tree
Showing 17 changed files with 906 additions and 865 deletions.
51 changes: 28 additions & 23 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module.exports = {
theme: "cosmos",
title: "Tendermint",
title: "Tendermint Core",
// locales: {
// "/": {
// lang: "en-US"
Expand All @@ -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,
Expand All @@ -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",
Expand Down Expand Up @@ -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"
}
]
},
Expand Down Expand Up @@ -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: [
[
Expand Down
10 changes: 0 additions & 10 deletions docs/.vuepress/public/logo.svg

This file was deleted.

4 changes: 2 additions & 2 deletions docs/.vuepress/styles/index.styl
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
:root
--accent-color #018A01
--background #222222
--color-link #018A01
--color-primary #00BB00
6 changes: 3 additions & 3 deletions docs/DOCS_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down
10 changes: 8 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -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!
Expand All @@ -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.
2 changes: 1 addition & 1 deletion docs/app-dev/indexing-transactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
```

Expand Down
16 changes: 8 additions & 8 deletions docs/guides/go-built-in.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand All @@ -54,7 +54,7 @@ $ echo $GOPATH

We'll start by creating a new Go project.

```sh
```bash
$ mkdir kvstore
$ cd kvstore
```
Expand All @@ -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
```
Expand Down Expand Up @@ -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
```
Expand All @@ -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

Expand All @@ -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
Expand All @@ -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",
Expand Down
18 changes: 9 additions & 9 deletions docs/guides/go.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand All @@ -57,7 +57,7 @@ $ echo $GOPATH

We'll start by creating a new Go project.

```sh
```bash
$ mkdir kvstore
$ cd kvstore
```
Expand All @@ -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
```
Expand Down Expand Up @@ -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
Expand All @@ -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

Expand All @@ -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

Expand All @@ -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
Expand All @@ -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",
Expand Down
Loading

0 comments on commit 5d4eee2

Please sign in to comment.