This is the source code for the website of the Janet programming language. It is a static website built with mendoza, a static site generator.

Build this website using the bundled janet amalgamated source.

git clone https://github.com/janet-lang/janet-lang.org
cd janet-lang.org
make
make run

To build, simply use make or make build.

This requires first installing inotify-tools, which can be installed easily on most Linux distros. To watch for changes, use make watch.

make run

All pages in the content directory with .mdz extension will be parsed by mendoza and converted to an html file of the same name but with the .html extension. The markup language is similar to that supported by Scribble, the Racket documentation tool, but of course is written in and is a dialect of Janet. See mendoza for more information.

Note that although spork's documentation is served via janet-lang.org, the corresponding source files live in the spork repository so in some cases it may be better to file issues and PRs there.

Simply add a file with the name of the binding you are giving examples for to the examples directory, with the .janet suffix.

Since Janet binding names can contain characters that are not-so-friendly to certain filesystem and/or operating system combinations, an escaping scheme is used.

For a given symbol, use the content/examples.janet script to generate an appropriate filename. For example, for array/new, invoking:

$ janet content/examples.janet array/new

should give the output:

array_47new.janet

If such a file already exists, you can simply add your example code to the existing file.

When building the site, the new examples will be included in the generated documentation. Make sure that your example has correct janet syntax, as syntax errors will cause the entire site to not build. If the example has valid syntax (has a 0 exit code when loaded with janet -k example/my-fn.janet), there may be a bug in the mendoza janet syntax highlighter and you open a bug in mendoza.