yargs.js.org

April 11, 2025 ยท View on GitHub

Build Status

www for Yargs, your favourite CLI option parser

Setup

This site is built with jekyll. To get started ensure you have ruby. Then:

  1. Install bundler.
$ [sudo] gem install bundler

  1. cd into this repository

  2. Install the dependencies.

$ bundle install
  1. Run jekyll:
$ bundle exec jekyll serve
  1. Make changes && view them on http://localhost:4000

Running Tests

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

Directory structure:

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

License

ISC