Skip to content

BasicUsage

Pawan Dubey edited this page Jul 8, 2015 · 1 revision

Griffin is sub command based like git, svn etc. Each command is documented well.

griffin [subcommand] [options..] [arguments...]

However there are only three subcommands for three scenarios:

  • To initiate a new Griffin site, use new:
griffin new [option] <path>
Options:

 <path>                   : creates a new skeleton site at the given path
 --help (-h)              : find help about this command (default: true)
 -name (-n) <folder_name> : name of the directory to be created (default: griffin)
  • To parse your content, use publish:
griffin publish [option]
Options:

 --help (-h)    : find help about this command (default: true)
 --quick (-q)   : Publish only the files which have changed since the last modification. (default: false)
 --rebuild (-r) : Rebuild the site from scratch. This may take time for more number of posts. (default: false)
  • To preview your site in your browser, use preview:
griffin preview [option]
Options:

 --help (-h)               : find help about this command (default: true)
 --port (-p) <port_number> : Port on which to launch the preview. Default to your configuredData. port. (default: 9090)