Code Monkey home page Code Monkey logo

walletconnect-docs's Introduction

WalletConnect Docs

This repo runs docs.walletconnect.com.

Source can be viewed in docs directory.

Running Locally

  1. pnpm install
  2. pnpm start
  3. Open http://localhost:3000/

Adding a New Page

  1. Create a new file in docs/
  2. Configure sidebars.js to create the sidebar link.

Editing a Page

  1. Open the file in docs/

Older versions are available in versioned_docs/.

Modifying routes

Whenever a route is changed DocSearch needs to crawl the website in order to keep the search engine working properly, this is scheduled once a week, it is therefore recommended to use redirects to avoid broken links. See link.

Customize Settings & Theme

  1. Open docusaurus.config.js

Tab Components

Important

While creating titles inside a tab it is recommended to use four number signs (#) to avoid overpopulating the table of content.

Platform Tabs

In your mdx file first import PlatformTabs and PlatformTabItem from docs/components/PlatformTabs and docs/components/PlatformTabItem relatively and wrap your content around them

You can find the supported platform in docs/components/PlatformTabs.js, they are grouped in an array called PLATFORM_MAP

import PlatformTabs from '../components/PlatformTabs'
import PlatformTabItem from '../components/PlatformTabItem'

<PlatformTabs
	groupId="anyId"
	activeOptions={["web","ios","android"]}
>
<PlatformTabItem value="web">

#### Heading here

Information related to web

</PlatformTabItem>
<PlatformTabItem value="ios">

#### Heading here

Information related to ios

</PlatformTabItem>
<PlatformTabItem value="android">

#### Heading here

Information related to android

</PlatformTabItem>
</PlatformTabs>

Custom Tabs

In your mdx file first import Tabs and TabItem and wrap your content around them

import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'

<Tabs>
<TabItem value="custom-a" label="Custom A">

#### Heading here

Here you can add all the information related to Custom A

</TabItem>
<TabItem value="custom-b" label="Custom B">

#### Heading here

Here you can add all the information related to Custom B

</TabItem>
</Tabs>

More

For more options, check the Docusaurus docs.

Archived v1.0 docs can be viewed in the v1.0 branch.

walletconnect-docs's People

Contributors

glitch-txs avatar pedrouid avatar boidushya avatar xzilja avatar llbartekll avatar crypblizz8 avatar finessevanes avatar elyniss avatar chris13524 avatar ignaciosantise avatar jakubuid avatar chadyj avatar bkrem avatar quetool avatar flypaper0 avatar kacperoak avatar devceline avatar gigajuwels avatar cali93 avatar talhaali00 avatar skibitsky avatar hackyguru avatar alexander-lsvk avatar rakowskiii avatar iljadaderko avatar sgc-code avatar abstractpoint avatar velvet-shark avatar radeknovis avatar ganchoradkov avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.