mirror of
https://github.com/tendermint/tendermint.git
synced 2026-01-04 20:23:59 +00:00
Docs theme latest (#4132)
* fix logo in footer * readme and version * fix logo in footer
This commit is contained in:
@@ -11,26 +11,30 @@ module.exports = {
|
||||
base: process.env.VUEPRESS_BASE,
|
||||
themeConfig: {
|
||||
docsRepo: "tendermint/tendermint",
|
||||
editLink: true,
|
||||
editLinks: true,
|
||||
docsDir: "docs",
|
||||
logo: "/logo.svg",
|
||||
label: "core",
|
||||
gutter: {
|
||||
title: "Help & Support",
|
||||
editLink: true,
|
||||
children: [
|
||||
{
|
||||
title: "Riot Chat",
|
||||
text: "Chat with Tendermint developers on Riot Chat.",
|
||||
highlighted: "500+ people chatting now"
|
||||
},
|
||||
{
|
||||
title: "Tendermint Forum",
|
||||
text: "Found an Issue?",
|
||||
highlighted:
|
||||
"Help us improve this page by suggesting edits on GitHub."
|
||||
}
|
||||
]
|
||||
chat: {
|
||||
title: "Riot Chat",
|
||||
text: "Chat with Tendermint developers on Riot Chat.",
|
||||
url: "https://riot.im/app/#/room/#tendermint:matrix.org",
|
||||
bg: "#222"
|
||||
},
|
||||
forum: {
|
||||
title: "Tendermint Forum",
|
||||
text: "Join the Tendermint forum to learn more",
|
||||
url: "https://forum.cosmos.network/c/tendermint",
|
||||
bg: "#0B7E0B",
|
||||
logo: "tendermint"
|
||||
},
|
||||
github: {
|
||||
title: "Found an Issue?",
|
||||
text: "Help us improve this page by suggesting edits on GitHub."
|
||||
}
|
||||
},
|
||||
footer: {
|
||||
logo: "/logo-bw.svg",
|
||||
|
||||
@@ -60,37 +60,27 @@ to send users to the GitHub.
|
||||
|
||||
## Building Locally
|
||||
|
||||
To build and serve the documentation locally, run:
|
||||
Make sure you are in the `docs` directory and run the following commands:
|
||||
|
||||
```
|
||||
# from this directory
|
||||
npm install -g vuepress
|
||||
```sh
|
||||
rm -rf node_modules
|
||||
```
|
||||
|
||||
NOTE: the command may require `sudo`.
|
||||
This command will remove old version of the visual theme and required packages. This step is optional.
|
||||
|
||||
then change the following line in the `.vuepress/config.js`:
|
||||
|
||||
```
|
||||
base: "/docs/",
|
||||
```sh
|
||||
npm install
|
||||
```
|
||||
|
||||
to:
|
||||
Install the theme and all dependencies.
|
||||
|
||||
```
|
||||
base: "/",
|
||||
```sh
|
||||
npm run serve
|
||||
```
|
||||
|
||||
Finally, go up one directory to the root of the repo and run:
|
||||
Run `pre` and `post` hooks and start a hot-reloading web-server. See output of this command for the URL (it is often https://localhost:8080).
|
||||
|
||||
```
|
||||
# from root of repo
|
||||
vuepress build docs
|
||||
cd dist/docs
|
||||
python -m SimpleHTTPServer 8080
|
||||
```
|
||||
|
||||
then navigate to localhost:8080 in your browser.
|
||||
To build documentation as a static website run `npm run build`. You will find the website in `.vuepress/dist` directory.
|
||||
|
||||
## Search
|
||||
|
||||
|
||||
748
docs/package-lock.json
generated
748
docs/package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@@ -4,7 +4,7 @@
|
||||
"description": "Welcome to the Tendermint Core documentation!",
|
||||
"main": "index.js",
|
||||
"dependencies": {
|
||||
"vuepress-theme-cosmos": "^1.0.41"
|
||||
"vuepress-theme-cosmos": "^1.0.54"
|
||||
},
|
||||
"devDependencies": {},
|
||||
"scripts": {
|
||||
|
||||
9431
package-lock.json
generated
9431
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user