Skip to content

icpleague/docs-ui

Repository files navigation

Customizing the UI for DFINITY Internet Computer Documentation

This project uses Antora to generate an interface for the DFINITY Internet Computer SDK site. The dfinity-docs-playbook pulls in the ui-bundle.zip file from this repo and the documentation from the the following repos to generate the static documentation site:

Development

Run gulp preview to run the project locally. Doing this uses the sample documentation (not the docs defined in dfinity-docs-playbook ).

Building the UI

Once you're happy with the changes, run gulp-bundle to generate a new ui-bundle.zip folder. The dfinity-docs-playbook repo references this zip file on the master branch.

Deployments

Deployments are handled automatically through netlify whenever commits to master happen on dfinity-docs-playbook. Since this repo doesn't trigger netlify deployments, you'll have to manually kick off a new deployment from Netlify.

Note

If you want to preview the site with actuall content before deploying, you can run antora antora-playbook.yml in dfinity-docs-playbook which will generate the site.

Further Antora Documentation

Further Antora Documentation