htmlgoddess-cli
Cli tool for the HTMLGoddess static site generator.
Usage
$ npm install -g @htmlgoddess/cli
$ htmlgoddess COMMAND
running command...
$ htmlgoddess (-v|--version|version)
@htmlgoddess/cli/0.4.4 darwin-x64 node-v12.18.1
$ htmlgoddess --help [COMMAND]
USAGE
$ htmlgoddess COMMAND
...
Commands
htmlgoddess a11y [PROJECTDIR]
htmlgoddess create [PROJECTDIR]
htmlgoddess format [PROJECTDIR]
htmlgoddess format:auto [PROJECTDIR]
htmlgoddess help [COMMAND]
htmlgoddess print [PROJECTDIR]
htmlgoddess print:auto [PROJECTDIR]
htmlgoddess publish [FILE]
htmlgoddess save [PROJECTDIR]
htmlgoddess serve [PROJECTPATH]
htmlgoddess serve:auto [FILE]
htmlgoddess a11y [PROJECTDIR]
runs accessibility validation
USAGE
$ htmlgoddess a11y [PROJECTDIR]
OPTIONS
-h, --help show CLI help
-s, --standard=Section508|WCAG2A|WCAG2AA|WCAG2AAA [default: WCAG2AA] Web Accessibility Guideline standard
-u, --url=url Run on individual URL
EXAMPLES
$ htmlgoddess a11y
$ htmlgoddess a11y http://localhost:3000/index.html
$ htmlgoddess a11y ./path/to/your/file.html
See code: lib/commands/a11y/index.js
htmlgoddess create [PROJECTDIR]
creates a new website project under the grace of the HTML Goddess
USAGE
$ htmlgoddess create [PROJECTDIR]
OPTIONS
-f, --force
-h, --help show CLI help
EXAMPLES
$ htmlgoddess create ./path/to/directory
$ htmlgoddess create
See code: lib/commands/create/index.js
htmlgoddess format [PROJECTDIR]
formats your HTML
USAGE
$ htmlgoddess format [PROJECTDIR]
OPTIONS
-f, --force
-h, --help show CLI help
-n, --name=name name to print
EXAMPLE
$ htmlgoddess format
See code: lib/commands/format/index.js
htmlgoddess format:auto [PROJECTDIR]
watches for changes and formats your HTML
USAGE
$ htmlgoddess format:auto [PROJECTDIR]
OPTIONS
-h, --help show CLI help
EXAMPLE
$ htmlgoddess format:auto
See code: lib/commands/format/auto.js
htmlgoddess help [COMMAND]
display help for htmlgoddess
USAGE
$ htmlgoddess help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
htmlgoddess print [PROJECTDIR]
compiles source html/css files from src and prints to docs folder
USAGE
$ htmlgoddess print [PROJECTDIR]
OPTIONS
-a, --[no-]a11y
-f, --force
-h, --help show CLI help
-n, --name=name name to print
EXAMPLES
$ htmlgoddess print
$ htmlgoddess print ./path/to/your/project
See code: lib/commands/print/index.js
htmlgoddess print:auto [PROJECTDIR]
describe the command here
USAGE
$ htmlgoddess print:auto [PROJECTDIR]
OPTIONS
-d, --debounce=debounce [default: 500]
-f, --force
-h, --help show CLI help
-n, --name=name name to print
EXAMPLE
$ htmlgoddess print
hello world wide web from ./src/hello.ts!
See code: lib/commands/print/auto.js
htmlgoddess publish [FILE]
publishes your saved changes to git
USAGE
$ htmlgoddess publish [FILE]
OPTIONS
-f, --force
-h, --help show CLI help
EXAMPLE
$ htmlgoddess publish
See code: lib/commands/publish/index.js
htmlgoddess save [PROJECTDIR]
saves all changes in your project
USAGE
$ htmlgoddess save [PROJECTDIR]
OPTIONS
-h, --help show CLI help
EXAMPLE
$ htmlgoddess save
See code: lib/commands/save/index.js
htmlgoddess serve [PROJECTPATH]
serves your website on a local webserver
USAGE
$ htmlgoddess serve [PROJECTPATH]
OPTIONS
-f, --force
-h, --help show CLI help
-n, --name=name name to print
EXAMPLE
$ htmlgoddess serve
See code: lib/commands/serve/index.js
htmlgoddess serve:auto [FILE]
serves your website and auto-reloads when changed.
USAGE
$ htmlgoddess serve:auto [FILE]
OPTIONS
-f, --force
-h, --help show CLI help
-n, --name=name name to print
EXAMPLE
$ htmlgoddess serve
See code: lib/commands/serve/auto.js