Skip to content

Using the CLI

Mathieu Dombrock edited this page Aug 5, 2021 · 1 revision

Once you have installed SteelSky globally via:

npm install -g steelsky

You should be able to use the steelsky command in any location you have permissions for.

Simply running the command in an empty directory will output something like the following:

Please create a 'config.js' file in this directory:
module.exports = {
  "sourcePath": "<path>/source",
  "layoutPath": "<path>/layout",
  "highlightStyle": "a11y-dark",
  "outPath": "<path>/out"
};
An example config file will now be created in the current directory...
Please edit this file and rename it to 'config.js' to continue.
Good bye!

In addition to this output, the software will attempt to create a config.example.js file in the current working directory. This file can be edited (if needed) and renamed to config.js.

When you run steelsky again, if the config file is found in the working directory, the software will attempt to build your static site based on the criteria provided in the config file.

Clone this wiki locally