Skip to content

Commit

Permalink
refactor(docs): install commands
Browse files Browse the repository at this point in the history
  • Loading branch information
tien committed Nov 4, 2024
1 parent 201312a commit 60d59a4
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 63 deletions.
48 changes: 6 additions & 42 deletions apps/docs/docs/getting-started/connect-wallets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,51 +19,15 @@ Additional dependencies are required if you use any of be bellow wallet type.

### [WalletConnect](https://walletconnect.com/)

{/* prettier-ignore-start */}

<Tabs>
<TabItem value="npm" label="npm" default>
```sh
npm add @reactive-dot/wallet-walletconnect
```
</TabItem>
<TabItem value="yarn" label="yarn">
```sh
yarn add @reactive-dot/wallet-walletconnect
```
</TabItem>
<TabItem value="pnpm" label="pnpm">
```sh
pnpm add @reactive-dot/wallet-walletconnect
```
</TabItem>
</Tabs>

{/* prettier-ignore-end */}
```bash npm2yarn
npm install @reactive-dot/wallet-walletconnect
```

### [Ledger](https://www.ledger.com/)

{/* prettier-ignore-start */}

<Tabs>
<TabItem value="npm" label="npm" default>
```sh
npm add @reactive-dot/wallet-ledger
```
</TabItem>
<TabItem value="yarn" label="yarn">
```sh
yarn add @reactive-dot/wallet-ledger
```
</TabItem>
<TabItem value="pnpm" label="pnpm">
```sh
pnpm add @reactive-dot/wallet-ledger
```
</TabItem>
</Tabs>

{/* prettier-ignore-end */}
```bash npm2yarn
npm install @reactive-dot/wallet-ledger
```

## Add wallets to the config

Expand Down
24 changes: 3 additions & 21 deletions apps/docs/docs/getting-started/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,27 +18,9 @@ This walks you through the process of creating a simple ReactiveDOT application.

First add ReactiveDOT, along with required packages as dependencies to your React project.

{/* prettier-ignore-start */}

<Tabs>
<TabItem value="npm" label="npm" default>
```sh
npm add @reactive-dot/react polkadot-api
```
</TabItem>
<TabItem value="yarn" label="yarn">
```sh
yarn add @reactive-dot/react polkadot-api
```
</TabItem>
<TabItem value="pnpm" label="pnpm">
```sh
pnpm add @reactive-dot/react polkadot-api
```
</TabItem>
</Tabs>

{/* prettier-ignore-end */}
```bash npm2yarn
npm install @reactive-dot/react polkadot-api
```

## Download & sync metadata

Expand Down
3 changes: 3 additions & 0 deletions apps/docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@ const config: Config = {
docs: {
sidebarPath: "./sidebars.ts",
editUrl: "https://github.com/tien/reactive-dot/tree/main/apps/docs",
remarkPlugins: [
[require("@docusaurus/remark-plugin-npm2yarn"), { sync: true }],
],
},
theme: {
customCss: "./src/css/custom.css",
Expand Down
1 change: 1 addition & 0 deletions apps/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
"dependencies": {
"@docusaurus/core": "^3.5.2",
"@docusaurus/preset-classic": "^3.5.2",
"@docusaurus/remark-plugin-npm2yarn": "^3.5.2",
"@mdx-js/react": "^3.1.0",
"clsx": "^2.1.1",
"docusaurus-plugin-typedoc-api": "^4.4.0",
Expand Down
21 changes: 21 additions & 0 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2792,6 +2792,19 @@ __metadata:
languageName: node
linkType: hard

"@docusaurus/remark-plugin-npm2yarn@npm:^3.5.2":
version: 3.5.2
resolution: "@docusaurus/remark-plugin-npm2yarn@npm:3.5.2"
dependencies:
mdast-util-mdx: "npm:^3.0.0"
npm-to-yarn: "npm:^2.2.1"
tslib: "npm:^2.6.0"
unified: "npm:^11.0.3"
unist-util-visit: "npm:^5.0.0"
checksum: 10c0/a9a7f212e0fad41c9c74184259eca37a838b6637b382f4ddee47f533036c292b0d6bdfcde93d8d7bed259baf8d4a36c7dd1456bfeb8bde5c4d92d3b4c7a99db7
languageName: node
linkType: hard

"@docusaurus/theme-classic@npm:3.5.2":
version: 3.5.2
resolution: "@docusaurus/theme-classic@npm:3.5.2"
Expand Down Expand Up @@ -4911,6 +4924,7 @@ __metadata:
"@docusaurus/core": "npm:^3.5.2"
"@docusaurus/module-type-aliases": "npm:3.5.2"
"@docusaurus/preset-classic": "npm:^3.5.2"
"@docusaurus/remark-plugin-npm2yarn": "npm:^3.5.2"
"@docusaurus/tsconfig": "npm:3.5.2"
"@docusaurus/types": "npm:3.5.2"
"@mdx-js/react": "npm:^3.1.0"
Expand Down Expand Up @@ -14805,6 +14819,13 @@ __metadata:
languageName: node
linkType: hard

"npm-to-yarn@npm:^2.2.1":
version: 2.2.1
resolution: "npm-to-yarn@npm:2.2.1"
checksum: 10c0/65c696a3e595facad802b6b13c04e504806ea88fd4f87ab758f8042c19f65b4c4822815a47095df944b0809a95e574c27323c33cca5533f8454515eaa6e14fac
languageName: node
linkType: hard

"nprogress@npm:^0.2.0":
version: 0.2.0
resolution: "nprogress@npm:0.2.0"
Expand Down

0 comments on commit 60d59a4

Please sign in to comment.