jbrook / docs

:open_file_folder: Wercker docs

wercker-docs

Wercker docs built with gulp and metalsmith.

Install

hub clone wercker/docs

Make sure to have npm>=2.0.0 installed to build local modules.

Running with wercker dev

wercker dev --publish 1337

Usage

Lifecycle scripts included in dev:
  postinstall
    echo 'linklocal' && linklocal link -r && linklocal list -r | bulk -c 'npm install'
  start
    npm run build && npm run open
  test
    semistandard

available via `npm run-script`:
  build
    gulp build
  clean
    rm -rf {cache,release,coverage}
  content
    gulp content
  open
    open http://localhost:1337 && httpster -d build -p 1337
  watch
    watchify index.js -t brfs -o build/bundle.js
  format
    semistandard-format -w

Style Guide

• Wercker must always be uppercase.
• Prefer American English
• All nouns which are normally two words in English should be written as two words. e.g.
  • Run time and not runtime
    • http://www.oed.com/view/Entry/168872?redirectedFrom=run-time#eid24818252
  • Query string
  • Start up
• Except terms of art, e.g.
  • Username
    • http://english.stackexchange.com/a/43440
• Capitalize proper nouns like Elasticsearch

License

MIT