Configuration
Nift in 101ween font

The configuration file for a Nift project is stored in .nift/config.json. You can check the location of the global configuration file when starting FLASHELL with nift sh.

Contents

Syntax

To use a command, enter nift command parameters or nsm command parameters in to a terminal, command prompt or power shell window.

Project Configuration Files

Each Nift project has its own configuration file located at .nift/config.json. The project configuration file for this website is: 

{
	"config": {
		"content-dir": "content/",
		"content-ext": ".content",
		"output-dir": "site/",
		"output-ext": ".html",
		"script-ext": ".f",
		"default-template": "template/page.template",
		"backup-scripts": true,
		"lolcat-default": false,
		"lolcat-cmd": "nift lolcat-cc -f",
		"build-threads": -1,
		"paginate-threads": -1,
		"incremental-mode": "modified",
		"terminal": "normal",
		"unix-editor": "subl -n",
		"windows-editor": "notepad",
		"root-branch": "stage",
		"output-branch": "master"
	}
}

Global Configuration File

Each system you have Nift installed on will have its own global configuration file, you can check the location of the global configuration file when starting FLASHELL with nift sh. 

{
    "config": {
        "lolcat-default": true,
        "lolcat-cmd": "lolcat-cc -f",
        "browser": "chromium-browser --new-window --incognito",
        "terminal": "*nix",
        "unix-editor": "subl -n",
        "windows-editor": "notepad"
    }
}

Configurable

The table below contains information about what can be configured in the configuration files:

Name Description Valid Values Global Project
content-dir path to content directory quoted path Y
content-ext extension used for content files quoted extension Y
output-dir path to output directory quoted path Y
output-ext extension used for build files quoted extension Y
script-ext extension used for pre/post build scripts quoted extension Y
default-template default template file to use when tracking new pages quoted path Y
backup-scripts backup scripts before running them {false,true} Y
build-threads max number of threads to use when building ($-x \rightarrow x*no\_cores$) integer Y
paginate-threads max number of threads to use with pagination ($-x \rightarrow x*no\_cores$) integer Y
incremental-mode choose between incremental mode using modification times or file hashes {modified, hash, hybrid} Y
lolcat-default whether to use lolcat for output {false,true} Y Y
lolcat-cmd quoted command to use when running lolcat eg. "nift lolcat-cc -f" Y Y
terminal mostly just to change output background colour for Powershell on Windows "ps" or "powershell" Y Y
unix-editor specifies which text editor to use on *nix machines eg. "subl -n" or "vi" Y Y
windows-editor specifies which text editor to use on Windows machines eg. "subl -n" or "notepad" Y Y
Name Description Valid Values Global Project