Welcome to the Plutus eBook project. This ebook is written using asciidoctor, we encourage you to consult its excellent documentation for more details.

The book content is in the doc directory, and Literate Haskell sources are in the src directory.

The Literate Haskell can be built with nix.

• Run nix build -f default.nix localPackages.plutus-book in the root of the repository.

  • Make sure you’ve followed How to set up the IOHK binary caches.

  • You can also use cabal or stack, see the main README for more about building Haskell packages.

The entry point to the book is plutus.adoc. This defines the main document attributes and includes all the chapters in sequence.

Chapters should be written in separate files (beginning the files with their sequence number is not essential but helpful), and included into plutus.adoc.

To use Literate Haskell:

• Write Haskell in asciidoc source blocks.

• Symlink the file into the src directory as a .lhs file.

• Add the module to plutus-book.cabal.

Unfortunately due to a quirk of how asciidoctor parses double colons, it’s tricky to write Haskell type signatures in the main text without them rendering wrong. To get around that, use an attribute reference {2c} instead of the colons.