https://github.com/flashbots/suave-docs
https://github.com/flashbots/suave-docs
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/flashbots/suave-docs
- Owner: flashbots
- License: cc-by-4.0
- Created: 2023-08-29T16:34:34.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-04T12:03:58.000Z (over 1 year ago)
- Last Synced: 2025-04-11T20:48:03.208Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://suave.flashbots.net
- Size: 14 MB
- Stars: 6
- Watchers: 17
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SUAVE Docs
Live at https://suave-alpha.flashbots.net
This website is built using [Docusaurus 3](https://docusaurus.io/docs), a modern static website generator.
## Getting started
Use Node.js v18+
```bash
# check out git submodules
git submodule init
git submodule update
```
Note: if you want to install the node packages from within a Docker container (recommended for security), then you can start it like this:
```bash
docker run -p 3000:3000 --name suave-docs --rm -it -w /mnt -v $(pwd):/mnt node:20 /bin/bash
# shortcut:
make docker
```
First create a copy of the environment file `.env.template` in the root of the codebase and rename it to `.env`:
```bash
cp .env.template .env
```
Then install the dependencies and serve the content:
```bash
# install dependencies
npm install
# start dev-server
npm start
# doing the same in Docker:
make docker-deps
make docker-start
```
Changes are reflected live without having to restart the server.
You can open the local docs at [http://localhost:3000/docs](http://localhost:3000/docs)
## Build
```bash
npm run build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Update suave-specs reference
Use this command to update to the latest version of suave-specs:
```bash
git submodule update --remote
```
## SUAVE-STD
The SUAVE standard library is automatically updated by [this CI workflow](.github/workflows/suave-std-sync.yml) and used with https://docusaurus.io/docs/sidebar/autogenerated
## Deployment
The docs use Vercel for hosting, and deployment is done by Vercel on any merge into the main branch.
## Icons
If you want to use icons, best copy the SVG from one of these:
- https://boxicons.com/
- https://icons.getbootstrap.com/
- https://feathericons.com/