Giter VIP home page Giter VIP logo

antora-sdk's Introduction

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

antora-sdk's People

Contributors

alexabsmith avatar andrewwylde avatar chenyan-dfinity avatar cplayit avatar dependabot[bot] avatar frmlnd avatar knl avatar lsgunnlsgunn avatar nomeata avatar olaszakos avatar scottsavarie avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

antora-sdk's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.