32 lines
1,017 B
Markdown
32 lines
1,017 B
Markdown
# 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/>
|
|
|
|
[Bootstrap]: http://getbootstrap.com/
|
|
[Favicon Generator]: https://realfavicongenerator.net/
|
|
[Font Awesome]: http://fontawesome.io/
|
|
[Jekyll]: http://jekyllrb.com/
|
|
[Markdown]: https://daringfireball.net/projects/markdown/
|
|
[Node.js]: http://nodejs.org/
|
|
[SASS]: https://sass-lang.com/
|
|
[Sfizz]: https://sfztools.github.io/sfizz
|
|
|