From a67c4a8142cdd9d807bfa28cd1d463e4d833fa24 Mon Sep 17 00:00:00 2001 From: Kim Gardner Date: Thu, 8 Mar 2018 12:49:18 -0500 Subject: [PATCH] Stub docs for Installing Plugins --- docs/source/04-02-installing-plugins.md | 32 +++++++++++++++++++ ...lt-plugins.md => 04-03-default-plugins.md} | 0 ...plugins.md => 04-04-additional-plugins.md} | 0 ...gin-recipes.md => 04-05-plugin-recipes.md} | 0 4 files changed, 32 insertions(+) create mode 100644 docs/source/04-02-installing-plugins.md rename docs/source/{04-02-default-plugins.md => 04-03-default-plugins.md} (100%) rename docs/source/{04-03-additional-plugins.md => 04-04-additional-plugins.md} (100%) rename docs/source/{04-04-plugin-recipes.md => 04-05-plugin-recipes.md} (100%) diff --git a/docs/source/04-02-installing-plugins.md b/docs/source/04-02-installing-plugins.md new file mode 100644 index 000000000..18aafe100 --- /dev/null +++ b/docs/source/04-02-installing-plugins.md @@ -0,0 +1,32 @@ +--- +title: Plugins Overview +permalink: /plugins/ +--- + +There are several ways to install plugins. + +### Default Plugins vs. Custom Plugins + +Talk ships with a default set of plugins, available in `plugins.default.json`. When you run Talk with just the default plugins, these are the plugins that will be enabled. + +If you want to use the additional plugins that are available, you can create a `plugins.json` file. If this file exists, Talk will use that to determine which plugins to use. + +### Installing a Plugin from npm + + +If you create your own plugin, you can publish the plugin to npm and use it in Talk. The npm package can be public (open source) or private. + +You would include this in your `plugins.json`: + +EXAMPLE HERE + +### Installing a Local Plugin + +If you host your own plugin on Github, you can enable it by adding this to your `plugins.json`: + +EXAMPLE HERE + +### Best Practice + + + diff --git a/docs/source/04-02-default-plugins.md b/docs/source/04-03-default-plugins.md similarity index 100% rename from docs/source/04-02-default-plugins.md rename to docs/source/04-03-default-plugins.md diff --git a/docs/source/04-03-additional-plugins.md b/docs/source/04-04-additional-plugins.md similarity index 100% rename from docs/source/04-03-additional-plugins.md rename to docs/source/04-04-additional-plugins.md diff --git a/docs/source/04-04-plugin-recipes.md b/docs/source/04-05-plugin-recipes.md similarity index 100% rename from docs/source/04-04-plugin-recipes.md rename to docs/source/04-05-plugin-recipes.md