sfizz/docs
2019-10-05 12:25:09 +02:00
..
_assets Updated documentation with opcode support status draft. 2019-10-03 22:49:01 +02:00
_data Show useful information only in documentation page status. 2019-10-05 12:25:09 +02:00
_includes Show useful information only in documentation page status. 2019-10-05 12:25:09 +02:00
_layouts Added website documentation. 2019-10-03 18:49:12 +02:00
_posts Added website documentation. 2019-10-03 18:49:12 +02:00
assets Updated documentation stylesheet. 2019-10-03 22:45:43 +02:00
news/archive Added website documentation. 2019-10-03 18:49:12 +02:00
search Added website documentation. 2019-10-03 18:49:12 +02:00
.editorconfig Added website documentation. 2019-10-03 18:49:12 +02:00
.gitattributes Added website documentation. 2019-10-03 18:49:12 +02:00
.gitignore Added website documentation. 2019-10-03 18:49:12 +02:00
.website.code-workspace Added website documentation. 2019-10-03 18:49:12 +02:00
404.md Added website documentation. 2019-10-03 18:49:12 +02:00
_config.yml Added website documentation. 2019-10-03 18:49:12 +02:00
atom.xml Added website documentation. 2019-10-03 18:49:12 +02:00
contacts.md Added website documentation. 2019-10-03 18:49:12 +02:00
downloads.md Added website documentation. 2019-10-03 18:49:12 +02:00
Gemfile Added website documentation. 2019-10-03 18:49:12 +02:00
index.md Updated documentation files. 2019-10-05 11:39:20 +02:00
new_post.pl Added website documentation. 2019-10-03 18:49:12 +02:00
package.json Added website documentation. 2019-10-03 18:49:12 +02:00
README.md Added website documentation. 2019-10-03 18:49:12 +02:00
robots.txt Added website documentation. 2019-10-03 18:49:12 +02:00
setup.sh Added website documentation. 2019-10-03 18:49:12 +02:00
status.md Updated documentation files. 2019-10-05 11:39:20 +02:00

Source code for the Sfizz documentation website

This 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.

Local Build Quick-start Guide

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

or manually:

$ gem update
$ gem install bundler
$ yarn --no-bin-links
$ yarn dist
$ bundle exec jekyll serve -w

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