hyperctl new website

hyperctl new website command

Overview

Start a new HyperTemplates website project.

Usage

 1$ hyperctl new website -h
 2Create a new website.
 3
 4Usage:
 5        hyperctl new website [options] <path>
 6
 7Options:
 8        -b, --baseurl      Base URL for the website. (required)
 9        -t, --title        Website title. (required)
10        -d, --description  Website description. (default: This website is powered by HyperTemplates.)
11            --format       Output format for the website configuration. (default: yaml)
12        -h, --help         Display help information.

Example

1$ hyperctl new website -b https://acme.com -t "Acme Inc" acme.com.website/
2website "acme.com.website/site.yaml" created

Options

<path>

The first ordered argument for the hyperctl new website command should be a path where the new website project will be created.

-b, --baseurl

Base URL to use for the new website.

Example

1--baseurl https://hypertemplates.net

-t, --title

The title to use for the new website.

See the website site.title reference for more information.

Example

1--title "HyperTemplates"

-d, --description

The description to use for the new website.

See the website site.description reference for more information.

Example

1--description "The pure-HTML templating system for the modern web."

--format

The output format to use for the website configuration file (site.yaml or site.json).

The supported formats are: yaml or json.

NOTE: the output format also dictates the website configuration file name.

Setting --format=yaml generates a site.yaml file in YAML format.

Setting --format=json generates a site.json file in JSON format.