Git Product home page Git Product logo

generate-networks-doc's Introduction

Generate Networks documentation

This project generates a Markdown formatted page including all of the network information for PoolTogether.

Usage

To generate markdown file Networks.md call:

$ yarn generate

To generate the markdown file and push changes to Gitbook (https://docs.pooltogether.com):

$ yarn generate-and-push

To update the Pools, artifacts and addresses just update the dependencies in package.json:

{
  // ...
  "dependencies": {
      "@pooltogether/current-pool-data": "^3.0.0-alpha.40",
      "@pooltogether/pooltogether-contracts": "^3.0.0-alpha.41",
  }
}

Setup

$ yarn

generate-networks-doc's People

Contributors

asselstine avatar

Stargazers

Roman Hossain Shaon avatar Thomas Erhel avatar

Watchers

James Cloos avatar Rob Secord avatar  avatar

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.