Skip to content

About

Source for docs.eez.io: the EEZ core protocol specification

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

EEZ Protocol Docs

Source for docs.eez.io, the specification of the EEZ core protocol contracts, built with Vocs.

The pages come from the docs/ folder of eez-core-protocol. To change a page, edit it there. This repo syncs it in and adds the site layout.

Develop

npm install
npm run dev

Sync from eez-core-protocol

git clone --depth 1 https://github.com/eez-association/eez-core-protocol /tmp/core
node scripts/sync-docs.mjs /tmp/core "$(git -C /tmp/core rev-parse --short HEAD)" src/pages

The synced commit is saved in src/sync.json.

Deploy

Pushing to main deploys to GitHub Pages. Pull requests build the site and check its links. The build also renders a preview image for each page, used when a link is shared.

About

Source for docs.eez.io: the EEZ core protocol specification

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages