www for Yargs, your favourite CLI option parser
This site is built with jekyll. To get started ensure you have ruby. Then:
- Install bundler.
$ [sudo] gem install bundler
-
cd
into this repository -
Install the dependencies.
$ bundle install
- Run jekyll:
$ bundle exec jekyll serve
- Make changes && view them on http:https://localhost:4000
We use html-proofer to validate the HTML structure of the site generated by jekyll. To run tests:
bundle exec htmlproof ./_site --only-4xx --check-favicon --check-html
Jekyll compiles directories in this repo to its own _site
directory. You will see it when you run jekyll serve
locally. Page files can be written in either .html
or .md
.
_includes/
-- These are you header/footer/head. They are then included in our basic layout.
docs/
-- Our docs page. Currently running using Flatdoc.
community/
-- Our community page. It is to be built out.
css/main.scss
-- basic sass variables used accross site
_sass/
-- sass layouts and other files.
js/
-- our basic js. They are not automatically compiled, and need to be included under _includes/head.html
_posts/
-- blog posts.
ISC