An open API service indexing awesome lists of open source software.

https://github.com/dapplets/dapplet-docs

Documentation for the Dapplet Platform. View at docs.dapplets.org
https://github.com/dapplets/dapplet-docs

Last synced: 5 months ago
JSON representation

Documentation for the Dapplet Platform. View at docs.dapplets.org

Awesome Lists containing this project

README

          

![dapplet-docs](/banners/dark.png#gh-dark-mode-only)
![dapplet-docs](/banners/light.png#gh-light-mode-only)

# Documentation for Dapplet Platform

Documentation for the Dapplet Platform. Includes instructions for using the [Dapplet Browser Extension](https://github.com/dapplets/dapplet-extension), [exercises](https://github.com/dapplets/dapplet-template) for creating dapplets and adapters for the platform, and documentation for community-created adapters.

View at [docs.dapplets.org](https://docs.dapplets.org/)

This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.

## Node Version

You must use **node 14** or above. We recommend [nvm](https://github.com/nvm-sh/nvm).

## Installation

```console
yarn install
```

## Local Development

```console
yarn start
```

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

## Build

```console
yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Deployment

```console
GIT_USER= USE_SSH=true yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.