-
-
Notifications
You must be signed in to change notification settings - Fork 197
Help for plugin commands #534
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
✅ |
ping @ikoevska |
[library](library.html) | You must run the library command with a related command. | ||
[plugin](plugin.html) | You must run the plugin command with a related command. | ||
[plugin add](plugin-add.html) | Installs a plugin and any packages that it depends on. | ||
<% } %> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you have closing }
, but there's no opening tag, this will cause build failure
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, the opening isHtml check is missing before Related Commands.
18d7772
to
2e3895c
Compare
✅ |
@@ -0,0 +1,28 @@ | |||
plugin add |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
plugin add
==========
Usage | Synopsis
------|-------
General | `$ tns plugin add <Plugin>`
<% if(isConsole) { %>Installs the specified plugin and any packages that it depends on.<% } %>
<% if(isHtml) { %>Installs the specified plugin and its dependencies in the local `node_modules` folder, adds it to the `dependencies` section in `package.json`, and prepares the plugin for all installed platforms. For more information about working with plugins, see [NativeScript Plugins](https://github.com/NativeScript/nativescript-cli/PLUGINS.md).<% } %>
### Attributes
* `<Plugin>` is a valid NativeScript plugin, specified by any of the following.
* A `<Name>` or `<Name>@<Version>` where `<Name>` is the name of a plugin that is published in the npm registry and `<Version>` is a valid version of this plugin.
* A `<Local Path>` to the directory which contains the plugin, including its `package.json` file.
* A `<Local Path>` to a `.tar.gz` archive containing a directory with the plugin and its `package.json` file.
* A `<URL>` which resolves to a `.tar.gz` archive containing a directory with the plugin and its `package.json` file.
* A `<git Remote URL>` which resolves to a `.tar.gz` archive containing a directory with the plugin and its `package.json` file.
<% if(isHtml) { %>
### Prerequisites
* Verify that the plugin that you want to add contains a valid `package.json` file. Valid `package.json` files contain a `nativescript` section.
### Related Commands
Command | Description
----------|----------
[library](library.html) | You must run the library command with a related command.
[library add](library-add.html) | Adds a native library to the current project.
[plugin](plugin.html) | Lists all installed plugins for your project or lets you manage the plugins for your project.
[plugin remove](plugin-remove.html) | Uninstalls the specified plugin and its dependencies.
<% } %>
Note that index.md also needs to be changed - you need to add the following entry:
|
2e3895c
to
6121dcb
Compare
✅ |
6121dcb
to
b08a565
Compare
✅ |
b08a565
to
1246860
Compare
✅ |
👍 I will fix plugins.md in a separate PR |
No description provided.