Skip to content

AIBlockOfficial/aiblock.dev

Repository files navigation

Website

This website is built using Docusaurus 2 and docusaurus-openapi-docs plugin.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. It will also execute "gen-all", regenerating all openAPI md files. (See package.json scripts)

Build

$ yarn build

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

Deployment

When submitting a PR against main the test-deploy workflow will run, this will ensure that the documentation builds successfully without deploying anything to github pages

When PRs are merged into main the deploy workflow will run, this will build and deploy documentation to github pages at the given custom url aiblock.dev

Docker

Build docker image:

docker build -t a-block-io .

Run image on http://localhost:8080:

docker run -p 8080:8080 a-block-io