Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/umaprotocol/docs
Repository for the official smart contract documentation of UMA.
https://github.com/umaprotocol/docs
blockchain defi ethereum
Last synced: 3 days ago
JSON representation
Repository for the official smart contract documentation of UMA.
- Host: GitHub
- URL: https://github.com/umaprotocol/docs
- Owner: UMAprotocol
- Created: 2020-07-11T06:57:34.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-05T21:48:04.000Z (over 1 year ago)
- Last Synced: 2023-03-07T11:27:36.756Z (over 1 year ago)
- Topics: blockchain, defi, ethereum
- Language: JavaScript
- Homepage: https://contracts.docs.umaproject.org/
- Size: 12.8 MB
- Stars: 9
- Watchers: 11
- Forks: 24
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# UMA Documentation Website
Repository for: https://docs.umaproject.org/
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern
static website generator.
Please read the instructions below if you need to run this project locally.
[](https://vercel.com/?utm_source=uma%2Fdocs)
### Installation
```
$ yarn
```
### Local Development
```
$ 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
You do not need to do this because our deployment process does the build
automatically (see deployment section below).
```
$ yarn build
```
This command generates static content into the `build` directory and can be
served using any static contents hosting service.
### Deployment (Vercel)
We have a team account on Vercel that watches the branches on this repo.
Whenever a new commit is pushed to the `master` branch (e.g. through merging a
PR), Vercel will deploy to https://docs.umaproject.org/.
### Deployment (Github)
This is not used because we are currently using Vercel for deployment/hosting.
These instructions are left here for posterity and reference only.
```
$ 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.