The Snap_!_ Reference Manual

by Brian Harvey, Jens Mönig

Read the Manual (PDF - coming soon) (Original PDF)orginal_pdf

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

Authors

Brian Harvey, Jens Mönig, Michael Ball, Jadge Hügle, Victoria Phelps

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

Writing Style

• The content/ folder contains the markdown files, organized by chapter.
  • Images sho
• The blockly/ folder contains 1 markdown file per block, organized by palette.
  • blocks/images/ one image per block.

VSCode and Editing

• Use the GitHub Codespace link to edit the book in the browser. https://quarto.org/docs/visual-editor/vscode/

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.

Published Book

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

Credits

License