Git Product home page Git Product logo

polkadot_network_directory's Introduction

Polkadot Network Directory

Documentation about Chains of the Polkadot and Kusama networks

Install tooling

Folders

  • chain_info: General information about chains in yaml format
  • chain_data: Data fetched onchain based on the chain_info (currently unused)

General idea

     chain_foo.yaml   \
     chain_bar.yaml    }    chains.json            }     mdbook
     chain_baz.yaml   /     markdown per chain    /

Usage

You can refresh the book using:

 just render

You can automatically watch the changes by using:

 just watch

If you want to serve a page showing the result, in another terminal, you may run:

 just serve

Editing content

The only content that needs editing are the yaml files under chain_info. Do NOT edit any of the markdown files, your changes will be lost.

Editing templates

You can find template files using:

 find . -name "*.tera"

There are 2 important templates:

  • templates/one.md.tera: This template is used to convert the input yaml data into a markdown file per chain
  • templates/summary.md.tera: This template is used to dynamically generate the summary of the book, it takes care of organising parachains under their parent relaychain

Reference file

During the generation, all the data is aggregated into a json file containing the information about all the chains.

This file can be found at https://paritytech.github.io/polkadot_network_directory/chains.json

polkadot_network_directory's People

Contributors

1xstj avatar andabak avatar arrudagates avatar chevdor avatar cowboy-bebug avatar drewstone avatar green-jay avatar jasl avatar librelois avatar moliholy avatar pierrebesson avatar sbalaguer avatar woss avatar yooml avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 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.