Nim by example

Content and build toolchain for Nim by Example, a site that teaches Nim via annotated example programs.

Overview

The Nim by Example site is built by extracting code and comments from source files in examples and rendering them via the templates into a static public directory. The source code implementing this build process is in src directory.

The built public directory can be served by any static content system.

Building

To build the site you'll need Node installed.

First, install the dependencies by running:

$ npm install

To run the build once:

$ npm run build

To keep building on file changes:

$ npm run watch

Nim files can be checked for corectness:

$ npm run build testNim

To generate out files from Nim source code:

$ npm run build outputNim

License

Contents of this repository are licensed under Creative Commons Attribution 3.0 Unported License.

Thanks

Thanks to Mark McGranaghan for Go by Example, which inspired this project.