Formatting

netlify · Jun 4, 2020 · 4526c6f · 4526c6f
1 parent a42671d
commit 4526c6f
Show file tree

Hide file tree

Showing 17 changed files with 169 additions and 183 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -34,18 +34,18 @@ netlify [command] help
 ## Commands
 
 <!-- AUTO-GENERATED-CONTENT:START (GENERATE_COMMANDS_LIST) -->
+
 ### [addons](/docs/commands/addons.md)
 
 (Beta) Manage Netlify Add-ons
 
-| Subcommand | description  |
-|:--------------------------- |:-----|
-| [`addons:auth`](/docs/commands/addons.md#addonsauth) | Login to add-on provider  |
-| [`addons:config`](/docs/commands/addons.md#addonsconfig) | Configure add-on settings  |
-| [`addons:create`](/docs/commands/addons.md#addonscreate) | Add an add-on extension to your site  |
-| [`addons:delete`](/docs/commands/addons.md#addonsdelete) | Remove an add-on extension to your site  |
-| [`addons:list`](/docs/commands/addons.md#addonslist) | List currently installed add-ons for site  |
-
+| Subcommand                                               | description                               |
+| :------------------------------------------------------- | :---------------------------------------- |
+| [`addons:auth`](/docs/commands/addons.md#addonsauth)     | Login to add-on provider                  |
+| [`addons:config`](/docs/commands/addons.md#addonsconfig) | Configure add-on settings                 |
+| [`addons:create`](/docs/commands/addons.md#addonscreate) | Add an add-on extension to your site      |
+| [`addons:delete`](/docs/commands/addons.md#addonsdelete) | Remove an add-on extension to your site   |
+| [`addons:list`](/docs/commands/addons.md#addonslist)     | List currently installed add-ons for site |
 
 ### [api](/docs/commands/api.md)
 
@@ -63,21 +63,19 @@ Create a new deploy from the contents of a folder
 
 Local dev server
 
-| Subcommand | description  |
-|:--------------------------- |:-----|
-| [`dev:exec`](/docs/commands/dev.md#devexec) | Exec command  |
-
+| Subcommand                                  | description  |
+| :------------------------------------------ | :----------- |
+| [`dev:exec`](/docs/commands/dev.md#devexec) | Exec command |
 
 ### [functions](/docs/commands/functions.md)
 
 Manage netlify functions
 
-| Subcommand | description  |
-|:--------------------------- |:-----|
-| [`functions:build`](/docs/commands/functions.md#functionsbuild) | Build functions locally  |
-| [`functions:create`](/docs/commands/functions.md#functionscreate) | Create a new function locally  |
-| [`functions:invoke`](/docs/commands/functions.md#functionsinvoke) | Trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions  |
-
+| Subcommand                                                        | description                                                                                                                                |
+| :---------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------- |
+| [`functions:build`](/docs/commands/functions.md#functionsbuild)   | Build functions locally                                                                                                                    |
+| [`functions:create`](/docs/commands/functions.md#functionscreate) | Create a new function locally                                                                                                              |
+| [`functions:invoke`](/docs/commands/functions.md#functionsinvoke) | Trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions |
 
 ### [init](/docs/commands/init.md)
 
@@ -95,31 +93,28 @@ Login to your Netlify account
 
 Open settings for the site linked to the current folder
 
-| Subcommand | description  |
-|:--------------------------- |:-----|
-| [`open:admin`](/docs/commands/open.md#openadmin) | Opens current site admin UI in Netlify  |
-| [`open:site`](/docs/commands/open.md#opensite) | Opens current site url in browser  |
-
+| Subcommand                                       | description                            |
+| :----------------------------------------------- | :------------------------------------- |
+| [`open:admin`](/docs/commands/open.md#openadmin) | Opens current site admin UI in Netlify |
+| [`open:site`](/docs/commands/open.md#opensite)   | Opens current site url in browser      |
 
 ### [sites](/docs/commands/sites.md)
 
 Handle various site operations
 
-| Subcommand | description  |
-|:--------------------------- |:-----|
-| [`sites:create`](/docs/commands/sites.md#sitescreate) | Create an empty site (advanced)  |
-| [`sites:delete`](/docs/commands/sites.md#sitesdelete) | Delete a site  |
-| [`sites:list`](/docs/commands/sites.md#siteslist) | List all sites you have access to  |
-
+| Subcommand                                            | description                       |
+| :---------------------------------------------------- | :-------------------------------- |
+| [`sites:create`](/docs/commands/sites.md#sitescreate) | Create an empty site (advanced)   |
+| [`sites:delete`](/docs/commands/sites.md#sitesdelete) | Delete a site                     |
+| [`sites:list`](/docs/commands/sites.md#siteslist)     | List all sites you have access to |
 
 ### [status](/docs/commands/status.md)
 
 Print status information
 
-| Subcommand | description  |
-|:--------------------------- |:-----|
-| [`status:hooks`](/docs/commands/status.md#statushooks) | Print hook information of the linked site  |
-
+| Subcommand                                             | description                               |
+| :----------------------------------------------------- | :---------------------------------------- |
+| [`status:hooks`](/docs/commands/status.md#statushooks) | Print hook information of the linked site |
 
 ### [switch](/docs/commands/switch.md)
 
@@ -133,5 +128,4 @@ Unlink a local folder from a Netlify site
 
 Watch for site deploy to finish
 
-
 <!-- AUTO-GENERATED-CONTENT:END -->
diff --git a/docs/commands/addons.md b/docs/commands/addons.md
@@ -11,6 +11,7 @@ For more information on add-ons see our [Netlify partner add-ons docs](https://w
 ## About
 
 <!-- AUTO-GENERATED-CONTENT:START (GENERATE_COMMANDS_DOCS) -->
+
 (Beta) Manage Netlify Add-ons
 
 **Usage**
@@ -19,14 +20,13 @@ For more information on add-ons see our [Netlify partner add-ons docs](https://w
 netlify addons
 ```
 
-| Subcommand | description  |
-|:--------------------------- |:-----|
-| [`addons:auth`](/docs/commands/addons.md#addonsauth) | Login to add-on provider  |
-| [`addons:config`](/docs/commands/addons.md#addonsconfig) | Configure add-on settings  |
-| [`addons:create`](/docs/commands/addons.md#addonscreate) | Add an add-on extension to your site  |
-| [`addons:delete`](/docs/commands/addons.md#addonsdelete) | Remove an add-on extension to your site  |
-| [`addons:list`](/docs/commands/addons.md#addonslist) | List currently installed add-ons for site  |
-
+| Subcommand                                               | description                               |
+| :------------------------------------------------------- | :---------------------------------------- |
+| [`addons:auth`](/docs/commands/addons.md#addonsauth)     | Login to add-on provider                  |
+| [`addons:config`](/docs/commands/addons.md#addonsconfig) | Configure add-on settings                 |
+| [`addons:create`](/docs/commands/addons.md#addonscreate) | Add an add-on extension to your site      |
+| [`addons:delete`](/docs/commands/addons.md#addonsdelete) | Remove an add-on extension to your site   |
+| [`addons:list`](/docs/commands/addons.md#addonslist)     | List currently installed add-ons for site |
 
 **Examples**
 
@@ -39,6 +39,7 @@ netlify addons:auth addon-xyz
 ```
 
 ---
+
 ## `addons:auth`
 
 Login to add-on provider
@@ -54,6 +55,7 @@ netlify addons:auth
 - name - Add-on slug
 
 ---
+
 ## `addons:config`
 
 Configure add-on settings
@@ -69,13 +71,13 @@ netlify addons:config
 - name - Add-on namespace
 
 ---
+
 ## `addons:create`
 
 Add an add-on extension to your site
 ...
 Add-ons are a way to extend the functionality of your Netlify site
 
-
 **Usage**
 
 ```bash
@@ -87,13 +89,13 @@ netlify addons:create
 - name - Add-on namespace
 
 ---
+
 ## `addons:delete`
 
 Remove an add-on extension to your site
 ...
 Add-ons are a way to extend the functionality of your Netlify site
 
-
 **Usage**
 
 ```bash
@@ -106,9 +108,10 @@ netlify addons:delete
 
 **Flags**
 
-- `force` (*boolean*) - delete without prompting (useful for CI)
+- `force` (_boolean_) - delete without prompting (useful for CI)
 
 ---
+
 ## `addons:list`
 
 List currently installed add-ons for site
@@ -121,7 +124,7 @@ netlify addons:list
 
 **Flags**
 
-- `json` (*boolean*) - Output add-on data as JSON
+- `json` (_boolean_) - Output add-on data as JSON
 
 ---
 

diff --git a/docs/commands/api.md b/docs/commands/api.md
@@ -7,11 +7,11 @@ title: Netlify CLI api command
 The `api` command will let you call any [Netlify open API methods](https://open-api.netlify.com/)
 
 <!-- AUTO-GENERATED-CONTENT:START (GENERATE_COMMANDS_DOCS) -->
+
 Run any Netlify API method
 
 For more information on available methods checkout https://open-api.netlify.com/ or run "netlify api --list"
 
-
 **Usage**
 
 ```bash
@@ -24,8 +24,8 @@ netlify api
 
 **Flags**
 
-- `data` (*option*) - Data to use
-- `list` (*boolean*) - List out available API methods
+- `data` (_option_) - Data to use
+- `list` (_boolean_) - List out available API methods
 
 **Examples**
 
@@ -34,5 +34,4 @@ netlify api --list
 netlify api getSite --data '{ "site_id": "123456"}'
 ```
 
-
 <!-- AUTO-GENERATED-CONTENT:END -->
diff --git a/docs/commands/build.md b/docs/commands/build.md
@@ -5,6 +5,7 @@ title: Netlify CLI build command
 # `build`
 
 <!-- AUTO-GENERATED-CONTENT:START (GENERATE_COMMANDS_DOCS) -->
+
 (Beta) Build on your local machine
 
 **Usage**
@@ -15,14 +16,13 @@ netlify build
 
 **Flags**
 
-- `dry` (*boolean*) - Dry run: show instructions without running them
-- `context` (*option*) - Build context
+- `dry` (_boolean_) - Dry run: show instructions without running them
+- `context` (_option_) - Build context
 
 **Examples**
 
 ```bash
 netlify build
 ```
 
-
 <!-- AUTO-GENERATED-CONTENT:END -->
diff --git a/docs/commands/deploy.md b/docs/commands/deploy.md
@@ -5,6 +5,7 @@ title: Netlify CLI deploy command
 # `deploy`
 
 <!-- AUTO-GENERATED-CONTENT:START (GENERATE_COMMANDS_DOCS) -->
+
 Create a new deploy from the contents of a folder
 
 Deploys from the build settings found in the netlify.toml file, or settings from the API.
@@ -16,9 +17,7 @@ The following environment variables can be used to override configuration file l
 
 Lambda functions in the function folder can be in the following configurations for deployment:
 
-
-Built Go binaries:
-------------------
+## Built Go binaries:
 
 ```
 functions/
@@ -27,9 +26,7 @@ functions/
 
 Build binaries of your Go language functions into the functions folder as part of your build process.
 
-
-Single file Node.js functions:
------------------------------
+## Single file Node.js functions:
 
 Build dependency bundled Node.js lambda functions with tools like netlify-lambda, webpack or browserify into the function folder as part of your build process.
 
@@ -38,8 +35,7 @@ functions/
 └── nameOfBundledNodeJSFunction.js
 ```
 
-Unbundled Node.js functions that have dependencies outside or inside of the functions folder:
----------------------------------------------------------------------------------------------
+## Unbundled Node.js functions that have dependencies outside or inside of the functions folder:
 
 You can ship unbundled Node.js functions with the CLI, utilizing top level project dependencies, or a nested package.json.
 If you use nested dependencies, be sure to populate the nested node_modules as part of your build process before deploying using npm or yarn.
@@ -59,9 +55,7 @@ project/
 
 Any mix of these configurations works as well.
 
-
-Node.js function entry points
------------------------------
+## Node.js function entry points
 
 Function entry points are determined by the file name and name of the folder they are in:
 
@@ -75,7 +69,6 @@ functions/
 
 Support for package.json's main field, and intrinsic index.js entrypoints are coming soon.
 
-
 **Usage**
 
 ```bash
@@ -84,17 +77,17 @@ netlify deploy
 
 **Flags**
 
-- `dir` (*option*) - Specify a folder to deploy
-- `functions` (*option*) - Specify a functions folder to deploy
-- `prod` (*boolean*) - Deploy to production
-- `branch` (*option*) - Specifies the branch for deployment. Useful for creating specific deployment URL's
-- `open` (*boolean*) - Open site after deploy
-- `message` (*option*) - A short message to include in the deploy log
-- `auth` (*option*) - Netlify auth token to deploy with
-- `site` (*option*) - A site ID to deploy to
-- `json` (*boolean*) - Output deployment data as JSON
-- `timeout` (*option*) - Timeout to wait for deployment to finish
-- `trigger` (*boolean*) - Trigger a new build of your site on Netlify without uploading local files
+- `dir` (_option_) - Specify a folder to deploy
+- `functions` (_option_) - Specify a functions folder to deploy
+- `prod` (_boolean_) - Deploy to production
+- `branch` (_option_) - Specifies the branch for deployment. Useful for creating specific deployment URL's
+- `open` (_boolean_) - Open site after deploy
+- `message` (_option_) - A short message to include in the deploy log
+- `auth` (_option_) - Netlify auth token to deploy with
+- `site` (_option_) - A site ID to deploy to
+- `json` (_boolean_) - Output deployment data as JSON
+- `timeout` (_option_) - Timeout to wait for deployment to finish
+- `trigger` (_boolean_) - Trigger a new build of your site on Netlify without uploading local files
 
 **Examples**
 
@@ -107,5 +100,4 @@ netlify deploy --auth $NETLIFY_AUTH_TOKEN
 netlify deploy --trigger
 ```
 
-
 <!-- AUTO-GENERATED-CONTENT:END -->