All Projects → sfzformat → sfzformat.github.io

sfzformat / sfzformat.github.io

Licence: CC0-1.0 license
SFZ Format documentation website

Programming Languages

HTML
75241 projects
Liquid
124 projects
javascript
184084 projects - #8 most used programming language
SCSS
7915 projects
python
139335 projects - #7 most used programming language
shell
77523 projects

Projects that are alternatives of or similar to sfzformat.github.io

docuowl
🦉 A documentation generator
Stars: ✭ 1,199 (+6952.94%)
Mutual labels:  documentation-website
symbiota-docs
Symbiota software centralized hub for documentation
Stars: ✭ 21 (+23.53%)
Mutual labels:  documentation-website
Musescore
MuseScore is an open source and free music notation software. For support, contribution, bug reports, visit MuseScore.org. Fork and make pull requests!
Stars: ✭ 6,546 (+38405.88%)
Mutual labels:  sfz

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.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].