diff options
Diffstat (limited to 'plugins/nanoc/README.md')
| -rw-r--r-- | plugins/nanoc/README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/plugins/nanoc/README.md b/plugins/nanoc/README.md new file mode 100644 index 000000000..d5d437d8a --- /dev/null +++ b/plugins/nanoc/README.md @@ -0,0 +1,20 @@ +# Nanoc plugin + +This plugin adds some aliases and autocompletion for common [Nanoc](https://nanoc.ws) commands. + +To use it, add `nanoc` to the plugins array in your zshrc file: + +```zsh +plugins=(... nanoc) +``` + +## Aliases + +| Alias | Command | Description | +|-------|-----------------------|-----------------------------------------------------------------------------------| +| n | `nanoc` | Main Nanoc command | +| nco | `nanoc compile` | Compile all items of the current site | +| ncs | `nanoc create-site` | Create a new site at the given path. The site will use the filesystem data source | +| nd | `nanoc deploy` | Deploy the compiled site to the destination (specified with `--target`) | +| np | `nanoc prune` | Remove files not managed by Nanoc from the output directory | +| nv | `nanoc view` | Start the static web server (on port 3000 and all IP addresses, unless specified) | |