NAME

qgoda init - Initialize a Qgoda site with a theme

SYNOPSIS

qgoda init [<global options>] [-f|--force] [-n|--npm=PROGRAM] [-s|--skip=TASK] [<repository>]

Try 'qgoda --help' for a description of global options.

DESCRIPTION

Initializes or updates a new Qgoda site with a pre-defined theme.

If repository is omitted, http://github.com/gflohr/qgoda-default is used.

If the current directory already contains a qgoda site, only new files are copied into it, unless the option '--force' was given.

The same applies to the update of the configuration file _config.yaml. If it exists, and the option '--force' was given, the current configuration is merged with the default remote configuration from the theme.

The command neither implies "qgoda build" nor "qgoda watch". If the theme configures an external helper program such as "yarn", "npm", "make" and so on, a warning is printed.

FORMAT OF REPOSITORY STRINGS

You can specify the repository in one of the following format:

git://github.com/gflohr/qgoda-site

git+ssh://example.com/foo/bar

git+http://github.com/gflohr/qgoda-site

git+https://github.com/gflohr/qgoda-site

git+file:///var/git/qgoda/fancy.git

All of these strings are passed as is to "git clone".

gflohr/qgoda-default

A shortcut for "git://github.com/gflohr/qgoda-default".

http://git.example.com/foo/bar.tar.gz

If a URI points to a archive file format, the archive is downloaded and extracted to the current directory.

file:///path/to/directory

The contents of the directory is copied.

OPTIONS

-f, --force

Update (and overwrite) files and merge configurations. You can give the option twice in order to also overwrite files which are considered "precious" by the theme author. Most themes will only consider markdown documents as precious.

-n, --npm=PROGRAM

Use PROGRAM instead of npm for initializing Node.JS dependencies.

You currently can not use yarn instead of npm!

-s, --skip=TASK

Skip task TASK. Current tasks are:

copy

Copy files from repository.

config

Update _config.yaml. Note that the configuration file is only updated, when the option "--force" was specified on the command-line.

node

Do not update the project with the Node Package Manager NPM.

You can specify the option multiple times if you want to skip multiple tasks.

-h, --help

Show this help page and exit.

SEE ALSO

qgoda(1), git(1)

QGODA

Part of Qgoda.