{"id":20433897,"url":"https://github.com/flashbots/suave-docs","last_synced_at":"2025-04-12T21:11:00.847Z","repository":{"id":227331281,"uuid":"684682991","full_name":"flashbots/suave-docs","owner":"flashbots","description":null,"archived":false,"fork":false,"pushed_at":"2024-12-04T12:03:58.000Z","size":14699,"stargazers_count":6,"open_issues_count":5,"forks_count":7,"subscribers_count":17,"default_branch":"main","last_synced_at":"2025-04-11T20:48:03.208Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://suave.flashbots.net","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flashbots.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-29T16:34:34.000Z","updated_at":"2024-10-08T07:54:31.000Z","dependencies_parsed_at":"2024-04-08T17:42:51.344Z","dependency_job_id":"604c6904-0af2-4643-a52d-2b0f19d7ab3d","html_url":"https://github.com/flashbots/suave-docs","commit_stats":null,"previous_names":["flashbots/suave-docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flashbots%2Fsuave-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flashbots%2Fsuave-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flashbots%2Fsuave-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flashbots%2Fsuave-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flashbots","download_url":"https://codeload.github.com/flashbots/suave-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248631676,"owners_count":21136562,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T08:22:12.917Z","updated_at":"2025-04-12T21:11:00.823Z","avatar_url":"https://github.com/flashbots.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SUAVE Docs\n\nLive at https://suave-alpha.flashbots.net\n\nThis website is built using [Docusaurus 3](https://docusaurus.io/docs), a modern static website generator.\n\n## Getting started\n\nUse Node.js v18+\n\n```bash\n# check out git submodules\ngit submodule init\ngit submodule update\n```\n\nNote: if you want to install the node packages from within a Docker container (recommended for security), then you can start it like this:\n\n```bash\ndocker run -p 3000:3000 --name suave-docs --rm -it -w /mnt -v $(pwd):/mnt node:20 /bin/bash\n\n# shortcut:\nmake docker\n```\n\nFirst create a copy of the environment file `.env.template` in the root of the codebase and rename it to `.env`:\n\n```bash\ncp .env.template .env\n```\n\nThen install the dependencies and serve the content:\n\n```bash\n# install dependencies\nnpm install\n\n# start dev-server\nnpm start\n\n# doing the same in Docker:\nmake docker-deps\nmake docker-start\n```\n\nChanges are reflected live without having to restart the server.\n\nYou can open the local docs at [http://localhost:3000/docs](http://localhost:3000/docs)\n\n## Build\n\n```bash\nnpm run build\n```\n\nThis command generates static content into the `build` directory and can be served using any static contents hosting service.\n\n## Update suave-specs reference\n\nUse this command to update to the latest version of suave-specs:\n\n```bash\ngit submodule update --remote\n```\n\n## SUAVE-STD\n\nThe 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\n\n## Deployment\n\nThe docs use Vercel for hosting, and deployment is done by Vercel on any merge into the main branch.\n\n## Icons\n\nIf you want to use icons, best copy the SVG from one of these:\n\n- https://boxicons.com/\n- https://icons.getbootstrap.com/\n- https://feathericons.com/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflashbots%2Fsuave-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflashbots%2Fsuave-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflashbots%2Fsuave-docs/lists"}