https://github.com/polywrap/documentation
https://github.com/polywrap/documentation
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/polywrap/documentation
- Owner: polywrap
- Created: 2021-03-23T16:06:37.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-11-03T18:37:33.000Z (over 2 years ago)
- Last Synced: 2025-04-13T00:55:33.475Z (about 1 year ago)
- Language: MDX
- Size: 27.1 MB
- Stars: 8
- Watchers: 11
- Forks: 14
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
👉 Read the Docs 👈
📓📓📓
# Polywrap Docs
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
### Installation
```
$ yarn reset
```
### Local Development
To fully rebuild and start a development server, run:
```
$ yarn start
```
This will rebuild all snippets and start a local development server. Most changes are reflected live.
To quickly start a development server, run:
```
$ yarn start:fast
```
This will rebuild docs without rebuilding snippets, and only changes to docs will be reflected live.
This is the fastest way of getting started after rebuilding, as usually snippets need to be built only once.
### Build
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
You can also host the build locally by running:
```
$ yarn serve
```