Skip to content

christophe-hall/sfzformat.github.io

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Source code for the SFZ Format website

Dependencies and license information

The website is built using Jekyll, using Node.js to compile all static assets including the Bootstrap library and built on along with the SASS stylesheets. Most of the content on the website is written using Markdown, making it extremely easy to write and maintain. Icons are provided by Font Awesome, favicons by Favicon Generator. Anchors headings are provided by jekyll-anchor-headings by Alleyo, licensed under the MIT license. Syntax highlighting is provided by highlight.js, BSD 3-Clause 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

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

About

SFZ Format documentation website

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 76.7%
  • Liquid 13.3%
  • Python 6.3%
  • JavaScript 1.8%
  • SCSS 1.0%
  • Shell 0.4%
  • Other 0.5%