Skip to content

Commit

Permalink
docs: Update Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rrr523 committed Sep 22, 2023
1 parent ba066dd commit 7f66123
Show file tree
Hide file tree
Showing 5 changed files with 62 additions and 48 deletions.
48 changes: 48 additions & 0 deletions doc-site/docs/Overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
sidebar_position: 1
---

You can find some package documentation below:

| Package | Description | Version |
| --- | --- | --- |
| [@bnb-chain/greenfield-js-sdk](https://github.com/bnb-chain/greenfield-js-sdk/tree/main/packages/chain-sdk/README.md) | A client library for Greenfield Chain | [![npm](https://img.shields.io/npm/v/%40bnb-chain%2Fgreenfield-js-sdk?color=blue)](https://www.npmjs.com/package/@bnb-chain/greenfield-js-sdk) |
| [@bnb-chain/greenfiled-file-handle](https://github.com/bnb-chain/greenfield-js-sdk/tree/main/packages/file-handle/README.md) | WASM module that handle file, such as `checksums` | [![npm](https://img.shields.io/npm/v/%40bnb-chain%2Fgreenfiled-file-handle?color=blue)](https://www.npmjs.com/package/@bnb-chain/greenfiled-file-handle) |
| [@bnb-chain/greenfield-zk-crypto](https://github.com/bnb-chain/greenfield-js-sdk/tree/main/packages/zk-crypto/README.md) | WASM module about sign crypto | [![npm](https://img.shields.io/npm/v/%40bnb-chain%2Fgreenfield-zk-crypto?color=blue)](https://www.npmjs.com/package/@bnb-chain/greenfield-zk-crypto) |
| [@bnb-chain/create-gnfd-app](https://github.com/bnb-chain/greenfield-js-sdk/tree/main/packages/create-gnfd-app/README.md) | Create Greenfield App Quickly | [![npm](https://img.shields.io/npm/v/%40bnb-chain%2Fcreate-gnfd-app?color=blue)](https://www.npmjs.com/package/@bnb-chain/create-gnfd-app) |

## Online Examples

* [Nextjs](https://codesandbox.io/p/github/rrr523/greenfield-nextjs-template/main)
* [Create React App](https://codesandbox.io/p/github/rrr523/greenfield-cra-template/main)
* [Vite](https://codesandbox.io/p/github/rrr523/greenfield-vite-template/main)

## Quick Start

You can use [`create-gnfd-app`](https://github.com/bnb-chain/greenfield-js-sdk/tree/main/packages/create-gnfd-app) to create a app quickly.

```bash
> npx @bnb-chain/create-gnfd-app
```

![](https://github.com/bnb-chain/greenfield-js-sdk/raw/alpha/packages/create-gnfd-app/example.gif)

## Supported JS environments

1. Modern browsers (Chromium, Firefox, Safari)
2. Browser extensions (Chromium, Firefox)
3. Nodejs

## Contribution

1. install dependencies

```bash
> pnpm install
```

2. Build package:
```bash
> pnpm run build
```

7 changes: 7 additions & 0 deletions doc-site/docs/api/_category.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"label": "API",
"position": 4,
"link": {
"type": "generated-index"
}
}
47 changes: 0 additions & 47 deletions doc-site/docs/intro.md

This file was deleted.

6 changes: 6 additions & 0 deletions doc-site/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@ const config = {
position: 'left',
label: 'Tutorial',
},
// {
// type: 'docSidebar',
// sidebarId: 'apiSidebar',
// position: 'left',
// label: 'API',
// },
// { to: '/blog', label: 'Blog', position: 'left' },
{
href: 'https://github.com/bnb-chain/greenfield-js-sdk',
Expand Down
2 changes: 1 addition & 1 deletion doc-site/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "greenfield-docs",
"name": "greenfield-js-sdk-docs",
"version": "0.0.0",
"private": true,
"scripts": {
Expand Down

0 comments on commit 7f66123

Please sign in to comment.