Browse Source

docs: versioned (#5241)

## Description

Version docs, unfortunately because there is no dropdown in the theme the way one could go see docs related to v0.32 is through `/master`

I am not the biggest fan of this approach but unfortunately it all we have until https://github.com/cosmos/vuepress-theme-cosmos/issues/91 is completed

Closes: #XXX
pull/5282/head
Marko 4 years ago
committed by GitHub
parent
commit
297573269a
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 70 additions and 57 deletions
  1. +1
    -1
      Makefile
  2. +67
    -56
      docs/.vuepress/config.js
  3. +2
    -0
      docs/versions

+ 1
- 1
Makefile View File

@ -169,7 +169,7 @@ DESTINATION = ./index.html.md
build-docs: build-docs:
cd docs && \ cd docs && \
while read p; do \ while read p; do \
(git checkout $${p} && npm install && VUEPRESS_BASE="/$${p}/" npm run build) ; \
(git checkout $${p} . && npm install && VUEPRESS_BASE="/$${p}/" npm run build) ; \
mkdir -p ~/output/$${p} ; \ mkdir -p ~/output/$${p} ; \
cp -r .vuepress/dist/* ~/output/$${p}/ ; \ cp -r .vuepress/dist/* ~/output/$${p}/ ; \
cp ~/output/$${p}/index.html ~/output ; \ cp ~/output/$${p}/index.html ~/output ; \


+ 67
- 56
docs/.vuepress/config.js View File

@ -1,6 +1,6 @@
module.exports = { module.exports = {
theme: "cosmos",
title: "Tendermint Core",
theme: 'cosmos',
title: 'Tendermint Core',
// locales: { // locales: {
// "/": { // "/": {
// lang: "en-US" // lang: "en-US"
@ -11,11 +11,11 @@ module.exports = {
// }, // },
base: process.env.VUEPRESS_BASE, base: process.env.VUEPRESS_BASE,
themeConfig: { themeConfig: {
repo: "tendermint/tendermint",
docsRepo: "tendermint/tendermint",
docsDir: "docs",
repo: 'tendermint/tendermint',
docsRepo: 'tendermint/tendermint',
docsDir: 'docs',
editLinks: true, editLinks: true,
label: "core",
label: 'core',
topbar: { topbar: {
banner: false, banner: false,
}, },
@ -23,114 +23,125 @@ module.exports = {
auto: true, auto: true,
nav: [ nav: [
{ {
title: "Resources",
title: 'Resources',
children: [ children: [
{ {
title: "Developer Sessions",
path: "/DEV_SESSIONS.html"
title: 'Developer Sessions',
path: '/DEV_SESSIONS.html'
}, },
{ {
title: "RPC",
path: "https://docs.tendermint.com/master/rpc/",
title: 'RPC',
path: 'https://docs.tendermint.com/master/rpc/',
static: true static: true
}
},
// TODO: remove once https://github.com/cosmos/vuepress-theme-cosmos/issues/91 is closed
{
title: 'Version 0.32',
path: '/v0.32',
static: true
},
{
title: 'Version 0.33',
path: '/v0.33',
static: true
},
] ]
} }
] ]
}, },
gutter: { gutter: {
title: "Help & Support",
title: 'Help & Support',
editLink: true, editLink: true,
forum: { forum: {
title: "Tendermint Forum",
text: "Join the Tendermint forum to learn more",
url: "https://forum.cosmos.network/c/tendermint",
bg: "#0B7E0B",
logo: "tendermint"
title: 'Tendermint Forum',
text: 'Join the Tendermint forum to learn more',
url: 'https://forum.cosmos.network/c/tendermint',
bg: '#0B7E0B',
logo: 'tendermint'
}, },
github: { github: {
title: "Found an Issue?",
text: "Help us improve this page by suggesting edits on GitHub."
title: 'Found an Issue?',
text: 'Help us improve this page by suggesting edits on GitHub.'
} }
}, },
footer: { footer: {
question: { 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."
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",
logo: '/logo-bw.svg',
textLink: { textLink: {
text: "tendermint.com",
url: "https://tendermint.com"
text: 'tendermint.com',
url: 'https://tendermint.com'
}, },
services: [ services: [
{ {
service: "medium",
url: "https://medium.com/@tendermint"
service: 'medium',
url: 'https://medium.com/@tendermint'
}, },
{ {
service: "twitter",
url: "https://twitter.com/tendermint_team"
service: 'twitter',
url: 'https://twitter.com/tendermint_team'
}, },
{ {
service: "linkedin",
url: "https://www.linkedin.com/company/tendermint/"
service: 'linkedin',
url: 'https://www.linkedin.com/company/tendermint/'
}, },
{ {
service: "reddit",
url: "https://reddit.com/r/cosmosnetwork"
service: 'reddit',
url: 'https://reddit.com/r/cosmosnetwork'
}, },
{ {
service: "telegram",
url: "https://t.me/cosmosproject"
service: 'telegram',
url: 'https://t.me/cosmosproject'
}, },
{ {
service: "youtube",
url: "https://www.youtube.com/c/CosmosProject"
service: 'youtube',
url: 'https://www.youtube.com/c/CosmosProject'
} }
], ],
smallprint: smallprint:
"The development of the Tendermint project is led primarily by Tendermint Inc., the for-profit entity which also maintains this website. Funding for this development comes primarily from the Interchain Foundation, a Swiss non-profit.",
'The development of the Tendermint project is led primarily by Tendermint Inc., the for-profit entity which also maintains this website. Funding for this development comes primarily from the Interchain Foundation, a Swiss non-profit.',
links: [ links: [
{ {
title: "Documentation",
title: 'Documentation',
children: [ children: [
{ {
title: "Cosmos SDK",
url: "https://docs.cosmos.network"
title: 'Cosmos SDK',
url: 'https://docs.cosmos.network'
}, },
{ {
title: "Cosmos Hub",
url: "https://hub.cosmos.network"
title: 'Cosmos Hub',
url: 'https://hub.cosmos.network'
} }
] ]
}, },
{ {
title: "Community",
title: 'Community',
children: [ children: [
{ {
title: "Tendermint blog",
url: "https://medium.com/@tendermint"
title: 'Tendermint blog',
url: 'https://medium.com/@tendermint'
}, },
{ {
title: "Forum",
url: "https://forum.cosmos.network/c/tendermint"
title: 'Forum',
url: 'https://forum.cosmos.network/c/tendermint'
} }
] ]
}, },
{ {
title: "Contributing",
title: 'Contributing',
children: [ children: [
{ {
title: "Contributing to the docs",
url: "https://github.com/tendermint/tendermint"
title: 'Contributing to the docs',
url: 'https://github.com/tendermint/tendermint'
}, },
{ {
title: "Source code on GitHub",
url: "https://github.com/tendermint/tendermint"
title: 'Source code on GitHub',
url: 'https://github.com/tendermint/tendermint'
}, },
{ {
title: "Careers at Tendermint",
url: "https://tendermint.com/careers"
title: 'Careers at Tendermint',
url: 'https://tendermint.com/careers'
} }
] ]
} }
@ -139,9 +150,9 @@ module.exports = {
}, },
plugins: [ plugins: [
[ [
"@vuepress/google-analytics",
'@vuepress/google-analytics',
{ {
ga: "UA-51029217-11"
ga: 'UA-51029217-11'
} }
] ]
], ],


+ 2
- 0
docs/versions View File

@ -1 +1,3 @@
v0.32
v0.33
master master

Loading…
Cancel
Save