Skip to content

Commit

Permalink
ibc-go documentation website (#146)
Browse files Browse the repository at this point in the history
* initial staging for ibc-go documentation

* fix up documentation site

* fix links, protobuf docs page

* rename custom to apps, fix link
  • Loading branch information
colin-axner authored May 4, 2021
1 parent 2c880a2 commit e012a4a
Show file tree
Hide file tree
Showing 32 changed files with 28,138 additions and 7,777 deletions.
179 changes: 179 additions & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,179 @@
module.exports = {
theme: "cosmos",
title: "IBC-Go",
locales: {
"/": {
lang: "en-US"
},
},
base: process.env.VUEPRESS_BASE || "/",
themeConfig: {
repo: "cosmos/ibc-go",
docsRepo: "cosmos/ibc-go",
docsDir: "docs",
editLinks: true,
label: "ibc",
// label: "ibc-go",
// TODO
//algolia: {
// id: "BH4D9OD16A",
// key: "ac317234e6a42074175369b2f42e9754",
// index: "ibc-go"
//},
versions: [
{
"label": "main",
"key": "main"
}
],
sidebar: {
auto: false,
nav: [
{
title: "Using IBC-Go",
children: [
{
title: "Overview",
directory: false,
path: "/ibc/overview.html"
},
{
title: "Integration",
directory: false,
path: "/ibc/integration.html"
},
{
title: "Applications",
directory: false,
path: "/ibc/apps.html"
},
{
title: "Upgrades",
directory: true,
path: "/ibc/upgrades"
},
{
title: "Governance Proposals",
directory: false,
path: "/ibc/proposals.html"
},
{
title: "Relayer",
directory: false,
path: "/ibc/relayer.html"
},
{
title: "Protobuf Documentation",
directory: false,
path: "/ibc/proto-docs.html"
},
]
},
{
title: "Migrations",
children: [
{
title: "v0.43 SDK to IBC-Go v1.0.0",
directory: false,
path: "/migrations/ibc-migration-043.html"
},
]
},
{
title: "Resources",
children: [
{
title: "IBC Specification",
path: "https://github.com/cosmos/ibc"
},
]
}
]
},
gutter: {
title: "Help & Support",
editLink: true,
chat: {
title: "Discord",
text: "Chat with IBC developers on Discord.",
url: "https://discordapp.com/channels/669268347736686612",
bg: "linear-gradient(225.11deg, #2E3148 0%, #161931 95.68%)"
},
github: {
title: "Found an Issue?",
text: "Help us improve this page by suggesting edits on GitHub."
}
},
footer: {
logo: "/logo-bw.svg",
textLink: {
text: "ibcprotocol.org",
url: "https://ibcprotocol.org"
},
links: [
{
title: "Documentation",
children: [
{
title: "Cosmos SDK",
url: "https://docs.cosmos.network"
},
{
title: "Cosmos Hub",
url: "https://hub.cosmos.network"
},
{
title: "Tendermint Core",
url: "https://docs.tendermint.com"
}
]
},
{
title: "Community",
children: [
{
title: "Cosmos blog",
url: "https://blog.cosmos.network"
},
{
title: "Forum",
url: "https://forum.cosmos.network"
},
{
title: "Chat",
url: "https://discord.gg/W8trcGV"
}
]
},
{
title: "Contributing",
children: [
{
title: "Contributing to the docs",
url:
"https://github.com/cosmos/ibc-go/blob/main/docs/DOCS_README.md"
},
{
title: "Source code on GitHub",
url: "https://github.com/cosmos/ibc-go/"
}
]
}
]
}
},
plugins: [
[
"@vuepress/google-analytics",
{
ga: "UA-51029217-2"
}
],
[
"sitemap",
{
hostname: "https://ibc.cosmos.network"
}
]
]
};
Binary file added docs/.vuepress/public/android-chrome-192x192.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/android-chrome-256x256.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/apple-touch-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions docs/.vuepress/public/browserconfig.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="utf-8"?>
<browserconfig>
<msapplication>
<tile>
<square150x150logo src="/mstile-150x150.png"/>
<TileColor>#da532c</TileColor>
</tile>
</msapplication>
</browserconfig>
Binary file added docs/.vuepress/public/favicon-16x16.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/favicon-32x32.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions docs/.vuepress/public/favicon-svg.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions docs/.vuepress/public/logo-bw.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit e012a4a

Please sign in to comment.