README.md

SFZ Format documentation website

The website is built using the following software and technologies:

• AnchorJS anchors headings, MIT license
• Bootstrap UI toolkit, code under MIT license, docs under Creative Commons
• Favicon Generator for favicons
• Fork Awesome for icons, SIL OFL 1.1 license
• highlight.js for syntax highlighting, BSD 3-Clause license
• Markdown markup language
• MKDocs static website generator, BSD-2-Clause license
• SASS for stylesheets, MIT license

Local Build Quick-start Guide

Install poetry and run:

$ poetry install
$ poetry run mkdocs serve

Use the automatic setup via mkdocs.sh

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

Creating posts

This can be done either manually by creating a new .md file in the mkdocs/docs/news/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.