README.md

Source code for the SFZ Format website

Dependencies and license information

The website is built using the following software and technologies:

• Bootstrap UI toolkit, code under MIT license, docs under Creative Commons
• Favicon Generator for favicons
• Font Awesome for icons, SIL OFL 1.1 license
• highlight.js for syntax highlighting, BSD 3-Clause license
• Jekyll static website generator, MIT license
• jekyll-anchor-headings by Alleyo, for anchors headings, MIT license
• Markdown markup language
• Node.js to compile all static assets, including the Bootstrap library, see license
• SASS for stylesheets, MIT license

Local Build Quick-start Guide

• Install ruby and yarn
• Use the automatic setup via setup.sh

or manually:

$ gem update --user-install
$ gem install bundler --user-install
$ bundle config set path '.bundle'
$ bundle install
$ yarn --no-bin-links
$ yarn dist
$ bundle exec jekyll serve --watch --host 0.0.0.0

The local website should be available at http://localhost:4000/

Creating posts

This can be done either manually by creating a new .md file in the _posts directory, paying attention for a correct filename, date and front-matter, or by running the following command:

$ ./new_post.sh "New post title" "<author_name>"

License

To the extent possible under law, sfz format team has waived all copyright and related or neighboring rights to sfz format website.