Skip to content

Latest commit

 

History

History
62 lines (49 loc) · 2.72 KB

README.md

File metadata and controls

62 lines (49 loc) · 2.72 KB
Raw

Crosschain Risk Framework

The Crosschain Risk Framework website provides a high-level systematic overview of the security risks in crosschain protocols by identifying, classifying, and analyzing the elements of risk inherent in the design, implementation and operation of such infrastructure. In addition, it profers a set of risk-controls and best practices to mitigate the likelihood and magnitude of various risks. This repository holds the source code behind the website.

Local Build

MkDocs is used to generate the documentation pages from the markdown files in this repository.

Prerequisites

  • Python 3.x.x

Install dependencies

Clone this repo, then cd into it and execute:

 make install

Build documentation

To build the documentation using MkDocs, execute the following:

make build

In addition to building the website, this will generate a copy of the website in PDF format.

Serve documentation locally

To view the documentation locally using MkDocs execute the command below. This will build and serve the documentation site locally, and automatically update the site if the underlying files are changed .

make serve

Then open a browser with the following address: http://127.0.0.1:8000/

Remote deployment

The website is automatically updated when new commits are pushed to the main branch. More specifically, the documentation site is generated from the updated source code on the main branch, and then committed to the gh-pages branch using Github actions. The updated files in gh-pages are then automatically deployed.

Note: do not edit files in the gh-pages branch as these files are overwritten each time a new PR is merged to the main branch.

PDF Generation

To generate a PDF version of the website:

  • Install: Weasy Print
  • Execute: pip install mkdocs-with-pdf
  • Add the following to the plugins section of the mkdocs.yml file: 
    - with-pdf:
        author: Crosschain Risk Framework Authors (see Authors and Contributing section)
        copyright: Copyright © 2022 Crosschain Risk Framework Authors
        cover_subtitle: PDF version of https://crosschainriskframework.github.io/
        output_path: ../CrosschainRiskFramework.pdf
        toc_level: 0
  • Execute: mkdocs build

More information about the mkdocs with PDF plugin can be found here: https://pypi.org/project/mkdocs-with-pdf/

How to contribute

See the Contribution section of the website.