Added config for docs (#530)

This commit is contained in:
Denis Fadeev 2020-05-29 03:11:30 +05:00 committed by GitHub
parent eb3cb55fd0
commit 5302976109
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 10637 additions and 1 deletions

6
.gitignore vendored
View File

@ -16,4 +16,8 @@ vendor
build
# IDE files
*.vscode
*.vscode
node_modules
docs/node_modules
docs/.vuepress/dist

10
docs/.vuepress/config.js Normal file
View File

@ -0,0 +1,10 @@
module.exports = {
theme: "cosmos",
title: "Kava Documentation",
themeConfig: {
logo: {
src: "/kava-logo.svg",
},
custom: true,
},
};

Binary file not shown.

After

Width:  |  Height:  |  Size: 464 B

View File

@ -0,0 +1,21 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 24.1.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
viewBox="0 0 1186 360" style="enable-background:new 0 0 1186 360;" xml:space="preserve">
<style type="text/css">
.st0{fill:#FF564F;}
</style>
<g>
<polygon class="st0" points="843.7,63.3 909.9,63.3 794.7,349.6 718.2,349.6 603,63.3 669.2,63.3 756.3,280.6 "/>
<rect x="9" y="4.1" class="st0" width="60.3" height="345.6"/>
<polygon class="st0" points="234.2,349.7 102.1,176.9 234.2,4.1 309.9,4.1 179.5,176.9 309.9,349.7 "/>
<path class="st0" d="M454.2,55.7c-66,0-115.7,36.5-119.3,90.8l-0.4,6.4h59.2l1-4.7c5.5-25.5,26.3-39.5,58.5-39.5
c35,0,55.1,17.6,55.1,48.4v17.7L434,179c-66.8,3.9-107.2,36.6-107.2,87.4c0,53.6,40.2,89.5,99.3,89.5c35.2,0,60.9-9.6,81.9-31.1
V351h60V152.5C568,93.7,522.6,55.7,454.2,55.7z M508.2,221.2V239c-3.9,38.9-30.8,63.3-72,65.3c-15.9,0.8-29.6-3.5-38.6-12.1
c-7.1-6.7-10.8-15.7-10.8-25.9c0-22.8,19.4-37.1,53.5-39.3L508.2,221.2z"/>
<path class="st0" d="M1063.2,55.7c-66,0-115.7,36.5-119.3,90.8l-0.4,6.4h59.2l1-4.7c5.5-25.5,26.3-39.5,58.5-39.5
c35,0,55.1,17.6,55.1,48.4v17.7l-74.2,4.2c-66.8,3.9-107.2,36.6-107.2,87.4c0,53.6,40.2,89.5,99.3,89.5c35.2,0,60.9-9.6,81.9-31.1
V351h60V152.5C1177,93.7,1131.6,55.7,1063.2,55.7z M1117.3,221.2V239c-3.9,38.9-30.8,63.3-72,65.3c-15.9,0.8-29.6-3.5-38.6-12.1
c-7.1-6.7-10.8-15.7-10.8-25.9c0-22.8,19.4-37.1,53.5-39.3L1117.3,221.2z"/>
</g>
</svg>

After

Width:  |  Height:  |  Size: 1.5 KiB

View File

@ -0,0 +1,4 @@
:root
--accent-color #ff554f
--background #161931
--ds-color-primary #ff554f

10533
docs/package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

23
docs/package.json Normal file
View File

@ -0,0 +1,23 @@
{
"name": "docs",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"preserve": "./pre.sh",
"serve": "trap 'exit 0' SIGINT; vuepress dev --no-cache",
"postserve": "./post.sh",
"prebuild": "./pre.sh",
"build": "trap 'exit 0' SIGINT; vuepress build --no-cache",
"postbuild": "./post.sh"
},
"keywords": [],
"author": "",
"license": "ISC",
"dependencies": {
"vuepress-theme-cosmos": "^1.0.166"
},
"devDependencies": {
"watchpack": "^1.6.1"
}
}

7
docs/post.sh Executable file
View File

@ -0,0 +1,7 @@
#!/usr/bin/env bash
for D in ../x/*; do
if [ -d "${D}" ]; then
rm -rf "./$(echo $D | awk -F/ '{print $NF}')"
fi
done

8
docs/pre.sh Executable file
View File

@ -0,0 +1,8 @@
#!/usr/bin/env bash
for D in ../x/*; do
if [ -d "${D}" ]; then
rm -rf "./$(echo $D | awk -F/ '{print $NF}')"
mkdir -p "./$(echo $D | awk -F/ '{print $NF}')" && cp -r $D/spec/* "$_"
fi
done

26
docs/readme.md Normal file
View File

@ -0,0 +1,26 @@
# Kava
## DeFi for Crypto.
Reference implementation of Kava, a blockchain for cross-chain DeFi. Built using the [cosmos-sdk](https://github.com/cosmos/cosmos-sdk).
## Mainnet
Note, the current recommended version of the software for mainnet is v0.3.2. The master branch of this repository contains considerable development work since the last mainnet release and is **not** runnable on mainnet.
### Installation
```sh
git checkout v0.3.2
make install
```
## Testnet
The recommended version of the software for kava-testnet-4000 is v0.4.1. For further information on joining the testnet, head over to the [testnet repo](https://github.com/Kava-Labs/kava-testnets).
## License
Copyright © Kava Labs, Inc. All rights reserved.
Licensed under the [Apache v2 License](LICENSE.md).