diff options
| author | Tuowen Zhao <ztuowen@gmail.com> | 2018-10-09 14:46:47 -0400 |
|---|---|---|
| committer | Tuowen Zhao <ztuowen@gmail.com> | 2018-10-09 14:46:47 -0400 |
| commit | 075160b86c64045e661209ad7906559068b44104 (patch) | |
| tree | a910a6eef6163d39859395bb0b416b2b184db9ac /plugins/nanoc/README.md | |
| parent | 5ece6ef2f07c58672a9c965dbbbb62a42386fb2d (diff) | |
| parent | 3c9942c4884089b290ef750468b29419ca0de271 (diff) | |
| download | zsh-075160b86c64045e661209ad7906559068b44104.tar.gz zsh-075160b86c64045e661209ad7906559068b44104.tar.bz2 zsh-075160b86c64045e661209ad7906559068b44104.zip | |
Merge branch 'master' of https://github.com/robbyrussell/oh-my-zsh
Diffstat (limited to 'plugins/nanoc/README.md')
| -rw-r--r-- | plugins/nanoc/README.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/plugins/nanoc/README.md b/plugins/nanoc/README.md new file mode 100644 index 000000000..9e21805f4 --- /dev/null +++ b/plugins/nanoc/README.md @@ -0,0 +1,23 @@ +# 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 | +| na | `nanoc autocompile` | The autocompile command has been deprecated since Nanoc 3.6. Use [guard-nanoc](https://github.com/nanoc/nanoc/tree/master/guard-nanoc) instead. | +| nco | `nanoc compile` | Compile all items of the current site. | +| nci | `nanoc create_item` | Command was deprecated in Nanoc v.3 and completely removed in v.4 | +| ncl | `nanoc create_layout` | Command was deprecated in Nanoc v.3 and completely removed in v.4 | +| ncs | `nanoc create_site` | Create a new site at the given path. The site will use the filesystem data source. | +| nd | `nanoc deploy` | Deploys the compiled site. The compiled site contents in the output directory will be uploaded to the destination, which is specified using the --target option. | +| nv | `nanoc view` | Start the static web server. Unless specified, the web server will run on port 3000 and listen on all IP addresses. | +| nw | `nanoc watch` | The watch command has been deprecated since Nanoc 3.6. Use [guard-nanoc](https://github.com/nanoc/nanoc/tree/master/guard-nanoc) instead. |
\ No newline at end of file |