Skip to content

Commit

Permalink
use vuepress for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
imuge authored and kauchy committed Dec 21, 2018
1 parent dfe40b3 commit c91ab65
Show file tree
Hide file tree
Showing 9 changed files with 81 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ qbase是QOS通用区块链应用框架,基于此框架开发QOS公链和联盟

## Quick Start

[Quick Start](./docs/quick_start.md)
[Quick Start](docs/getting-started/quick_start.md)

## 已实现区块链应用
* [qos](https://github.com/QOSGroup/qos),QOS公链,支持双层代币和跨链交易
Expand Down
45 changes: 45 additions & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
module.exports = {
title: "qbase",
description: "Documentation for the qbase.",
dest: "./dist/docs",
base: "/docs/",
markdown: {
lineNumbers: true
},
themeConfig: {
lastUpdated: "Last Updated",
nav: [{text: "Back to qbase", link: "https://www.github.com/qbaseGroup/qbase"}],
sidebar: [
{
title: "Introduction",
collapsable: false,
children: [
["/introduction/qbase", "qbase"]
]
},
{
title: "Getting Started",
collapsable: false,
children: [
["/getting-started/quick_start", "Quick Start"]
]
},
{
title: "Client",
collapsable: false,
children: [
["/client/command", "command"]
]
}
,
{
title: "Spec",
collapsable: false,
children: [
["/spec/qcp", "QCP"],
["/spec/transaction", "Transaction"]
]
}
]
}
}
3 changes: 3 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Welcome to qbase.

Docs for qbase.
File renamed without changes.
8 changes: 4 additions & 4 deletions docs/quick_start.md → docs/getting-started/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ type YourAccount struct {

## QCP跨链协议

参见: [QCP](../docs/qcp.md)
参见: [QCP](../spec/qcp.md)

## 扩展

Expand Down Expand Up @@ -249,11 +249,11 @@ baseapp.RegisterCustomQueryHandler(customQueryHandler)

## 客户端命令

参见: [客户端命令](../docs/command.md)
参见: [客户端命令](../client/command.md)

## 示例

* [basecoin](../example/basecoin/README.md)
* [basecoin](../../example/basecoin/README.md)

* [kvstore](../example/kvstore/README.md)
* [kvstore](../../example/kvstore/README.md)

21 changes: 21 additions & 0 deletions docs/introduction/qbase.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# qbase

qbase是QOS通用区块链应用框架,基于此框架开发QOS公链和联盟区块链应用,提供了通用的存储、交易和QCP跨链协议。

感谢tendermint团队,此框架基于[tendermint](https://github.com/tendermint/tendermint)研发,实现了ABCI应用的通用封装。

感谢cosmos团队,本框架实现参考了[cosmos-sdk](https://github.com/cosmos/cosmos-sdk)代码。

当前非正式版本,我们会持续完善。

## Examples
* [kvstore](https://github.com/QOSGroup/qbase/blob/master/example/kvstore)
* [basecoin](https://github.com/QOSGroup/qbase/tree/master/example/basecoin)

## Quick Start

[Quick Start](../getting-started/quick_start.md)

## 已实现区块链应用
* [qos](https://github.com/QOSGroup/qos),QOS公链,支持双层代币和跨链交易
* [qstars](https://github.com/QOSGroup/qstars),星云联盟链
6 changes: 6 additions & 0 deletions docs/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"scripts": {
"docs:dev": "vuepress dev docs",
"docs:build": "vuepress build docs"
}
}
2 changes: 1 addition & 1 deletion docs/qcp.md → docs/spec/qcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### 业务流程

![qcp-arth](https://github.com/QOSGroup/static/blob/master/qcp_relay_qos.jpg)
![qcp-arth](https://github.com/QOSGroup/static/blob/master/qcp_relay_qos.jpg?raw=true)

### 数据存储

Expand Down
File renamed without changes.

0 comments on commit c91ab65

Please sign in to comment.