56d02edb4f4a9aebaa69473a7676215ab25d8678

Author
Sergey Lysenko <soulwish.ls@gmail.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

nanoc: add README (#7252)

Diff

 1diff --git a/plugins/nanoc/README.md b/plugins/nanoc/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..9e21805f44f86d7ee04dfca30688058a26c2f319
 4--- /dev/null
 5+++ b/plugins/nanoc/README.md
 6@@ -0,0 +1,23 @@
 7+# Nanoc plugin
 8+
 9+This plugin adds some aliases and autocompletion for common [Nanoc](https://nanoc.ws) commands.
10+
11+To use it, add `nanoc` to the plugins array in your zshrc file:
12+
13+```zsh
14+plugins=(... nanoc)
15+```
16+
17+## Aliases
18+
19+| Alias | Command               | Description                                        |
20+|-------|-----------------------|----------------------------------------------------|
21+| n     | `nanoc`               | Main Nanoc command                                 |
22+| 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. |
23+| nco   | `nanoc compile`       | Compile all items of the current site. |
24+| nci   | `nanoc create_item`   | Command was deprecated in Nanoc v.3 and completely removed in v.4 |
25+| ncl   | `nanoc create_layout` | Command was deprecated in Nanoc v.3 and completely removed in v.4 |
26+| ncs   | `nanoc create_site`   | Create a new site at the given path. The site will use the filesystem data source. |
27+| 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. |
28+| nv    | `nanoc view`          | Start the static web server. Unless specified, the web server will run on port 3000 and listen on all IP addresses. |
29+| 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. |