The Snap_!_ Reference Manual

by Brian Harvey, Jens Mönig

Read the Manual (PDF - coming soon)

The reference manual for the Snap! programming language. (GitHub)

Authors

Brian Harvey & Jens Mönig

2025 Rewrite

There are 3 compoents, for the most part, you should focus on working the Quarto to render the Snap! manual.also

Quarto

This version of the Snap! manual is built using Quarto.

Brief installation guide

You need:

• Quarto
• Pandoc
• LaTeX

macOS:

brew install quarto
brew install pandoc
brew install mactex-no-gui

It is also recommended to install the [Quarto VSCode extension][quarto_vscode]. [quarto_vscode]: https://marketplace.visualstudio.com/items?itemName=quarto.quarto

Building the book

While writing content:

quarto preview

This will automatically build the web version and display it in the browser. Your webpage will automatically refresh as you save changes to files.

To compile the PDF and final version:

quarto render

JupyterBook

You can use JuypterBook 2 (alpha) to also build the book.

Instructions coming soon.

Document Conversion

If you are making large updates to the md structure, it may be worth working on the script to convert the Word document to markdown. The script assumes you have pandoc installed and available in your path.

cd conversion
ruby convert-word-doc.rb

This conversion script dumps content into conversion/chapters/ and then copies it into the content/ folder.

Hosting the book

The website is hosted on GitHub pages, compiled by the quarto.yml workflow. The PDF is... TBD.

Credits

License