Cardano Blueprint

Welcome to the Cardano Blueprint, a project that aims to serve as a knowledge foundation about how the Cardano protocol works. Blueprints are implementation independent assets, diagrams, specifications, test data, etc. that will enable a wide developer audience to understand the protocol and build Cardano components.

👉 Introduction 👈

Building

The blueprints are written using markdown and can be viewed directly in Github or built into the HTML site using mdbook.

With cargo

You can install mdbook and the plugins we use with cargo:

cargo install mdbook mdbook-katex mdbook-mermaid mdbook-alerts mdbook-toc

Then, build with:

mdbook build

Binary install

There's also an option to install directly from binaries with cargo binstall:

cargo install cargo-binstall         # If you don't already have it
cargo binstall mdbook mdbook-katex mdbook-mermaid mdbook-alerts mdbook-toc

With nix

You can also use nix:

nix build -o out

Editing

With mdbook installed or inside a nix develop shell, you can live preview the result with:

mdbook serve --open

See the mdbook manual or github flavored markdown for more information on what is available for editing.

Formatting & spell checking

We use treefmt that runs a few formatting and spell checking tools. This is also enforced through CI. See formattingPkgs in flake.nix for a list of packages needed, then:

treefmt

License

Cardano Blueprint created by the Cardano Blueprint contributors is licensed under the Apache 2.0 License.

Logo

The logo and wordmark for the Cardano Blueprint was created by Roberto Nicolo, Sebastian Nagel and Input Output Global Ltd. Obviously, the design is derived from the official Cardano logo and we hereby accept and intend to follow the official trademark policy. Cardano Blueprint is NOT registered as a trademark, nor shall it represent a commercial product, but any artifacts produced are covered under an open source license.

---

Thanks for visiting and hopefully the cardano blueprint is useful to you 💙!