diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 2be89081aff..e9f61640bbb 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -16,7 +16,7 @@ Use the commands below to provide key information from your environment: You do NOT have to include this information if this is a FEATURE REQUEST --> -**- Do you want to request a *feature* or report a *bug*?** +**- Do you want to request a _feature_ or report a _bug_?** **- What is the current behavior?** diff --git a/CHANGELOG.md b/CHANGELOG.md index ff8d3e81480..1d8c0c0f971 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -123,7 +123,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog). ### Commits -- RulesProxy: Make sure _redirects works with dev [`27f92f2`](https://github.com/netlify/cli/commit/27f92f23148f7250e63a1586744d155a54751cd5) +- RulesProxy: Make sure \_redirects works with dev [`27f92f2`](https://github.com/netlify/cli/commit/27f92f23148f7250e63a1586744d155a54751cd5) - update logo [`3984bbb`](https://github.com/netlify/cli/commit/3984bbb1c4177fb410f9100d83baac7875ea0025) - Dev: Make stdio more maintainable [`4cbdb02`](https://github.com/netlify/cli/commit/4cbdb02ca85c7680b9c469aad5ce725e3975f86f) @@ -135,11 +135,11 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog). - Dev: Make functions port configureable [`#525`](https://github.com/netlify/cli/pull/525) - Fix port for proxy redirects [`#520`](https://github.com/netlify/cli/pull/520) - Rules Proxy: Pass on query parameters [`#519`](https://github.com/netlify/cli/pull/519) -- Import rules-proxy and and redirect-parser [`#518`](https://github.com/netlify/cli/pull/518) +- Import rules-proxy and and redirect-parser [`#518`](https://github.com/netlify/cli/pull/518) - Consider sites from different team in Netlify link [`#500`](https://github.com/netlify/cli/pull/500) - Improve prompts for `link` command [`#502`](https://github.com/netlify/cli/pull/502) - Add Parcel detector [`#505`](https://github.com/netlify/cli/pull/505) -- rename deploy path [`#508`](https://github.com/netlify/cli/pull/508) +- rename deploy path [`#508`](https://github.com/netlify/cli/pull/508) - Improve analytics [`#513`](https://github.com/netlify/cli/pull/513) - Update ISSUE_TEMPLATE.md [`#504`](https://github.com/netlify/cli/pull/504) - Neltify -> Netlify [`#512`](https://github.com/netlify/cli/pull/512) @@ -489,7 +489,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog). - update netlify dev plugin [`514d759`](https://github.com/netlify/cli/commit/514d7591609fbd645c1de87f47200099e6919abe) - Add a test for raw parsing [`deb4cb9`](https://github.com/netlify/cli/commit/deb4cb97cf0ef12efba83b07c719064e9e16342e) -- Use conventional file casing [`60ad9d0`](https://github.com/netlify/cli/commit/60ad9d07c5a43ea24e78b63d70955e1a11dacc13) +- Use conventional file casing [`60ad9d0`](https://github.com/netlify/cli/commit/60ad9d07c5a43ea24e78b63d70955e1a11dacc13) ## [v2.11.7](https://github.com/netlify/cli/compare/v2.11.6...v2.11.7) - 2019-04-10 @@ -703,7 +703,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog). ### Commits - Run `npm up` [`29f16fa`](https://github.com/netlify/cli/commit/29f16fa376a55093b09d0c14a67e6ab68a5718f7) -- Update js-client providing zip-n-ship capabilities [`f9774a2`](https://github.com/netlify/cli/commit/f9774a29781c37d10875563c6221c2b92d2d7800) +- Update js-client providing zip-n-ship capabilities [`f9774a2`](https://github.com/netlify/cli/commit/f9774a29781c37d10875563c6221c2b92d2d7800) - Update deps [`985e8da`](https://github.com/netlify/cli/commit/985e8da37e162fefabfd27ac5bf6e567ba7ea790) ## [v2.6.6](https://github.com/netlify/cli/compare/v2.6.5...v2.6.6) - 2019-01-31 @@ -714,7 +714,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog). ### Commits -- Run prune before shrink-wrap [`761fcc5`](https://github.com/netlify/cli/commit/761fcc5660c8ac2a293afde661a129a0c8fbee84) +- Run prune before shrink-wrap [`761fcc5`](https://github.com/netlify/cli/commit/761fcc5660c8ac2a293afde661a129a0c8fbee84) ## [v2.6.5](https://github.com/netlify/cli/compare/v2.6.4...v2.6.5) - 2019-01-31 @@ -751,7 +751,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog). ### Commits -- Update js-client to fix rate limit handling [`32590eb`](https://github.com/netlify/cli/commit/32590ebf2aa9788733908afee3aefd87f21e9bb8) +- Update js-client to fix rate limit handling [`32590eb`](https://github.com/netlify/cli/commit/32590ebf2aa9788733908afee3aefd87f21e9bb8) ## [v2.6.2](https://github.com/netlify/cli/compare/v2.6.1...v2.6.2) - 2019-01-19 @@ -841,7 +841,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog). ### Commits -- Fix missing dependencies [`4dd06ad`](https://github.com/netlify/cli/commit/4dd06ad5bf53d62355e2f126bcc641786dba4139) +- Fix missing dependencies [`4dd06ad`](https://github.com/netlify/cli/commit/4dd06ad5bf53d62355e2f126bcc641786dba4139) ## [v2.2.2](https://github.com/netlify/cli/compare/v2.2.1...v2.2.2) - 2018-11-26 @@ -965,7 +965,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog). ### Commits - add root to this.netlify.site [`9104cf2`](https://github.com/netlify/cli/commit/9104cf2df283e19b4565daeb7f9c7a695a5bc419) -- Use dirname, not base name [`73b594c`](https://github.com/netlify/cli/commit/73b594c1bb8dc024ecca8d1a1c9a42ab0b953317) +- Use dirname, not base name [`73b594c`](https://github.com/netlify/cli/commit/73b594c1bb8dc024ecca8d1a1c9a42ab0b953317) ## [v2.0.0-beta.8](https://github.com/netlify/cli/compare/v2.0.0-beta.7...v2.0.0-beta.8) - 2018-10-09 diff --git a/README.md b/README.md index 566bc1f094b..3fc768570f9 100644 --- a/README.md +++ b/README.md @@ -16,20 +16,20 @@ Welcome to the Netlify CLI! The new 2.0 version was rebuilt from the ground up t - [Usage](#usage) - [Documentation](#documentation) - [Commands](#commands) - * [addons](#addons) - * [api](#api) - * [deploy](#deploy) - * [dev](#dev) - * [functions](#functions) - * [init](#init) - * [link](#link) - * [login](#login) - * [open](#open) - * [sites](#sites) - * [status](#status) - * [switch](#switch) - * [unlink](#unlink) - * [watch](#watch) + - [addons](#addons) + - [api](#api) + - [deploy](#deploy) + - [dev](#dev) + - [functions](#functions) + - [init](#init) + - [link](#link) + - [login](#login) + - [open](#open) + - [sites](#sites) + - [status](#status) + - [switch](#switch) + - [unlink](#unlink) + - [watch](#watch) - [Contributing](#contributing) - [Development](#development) - [License](#license) @@ -67,18 +67,18 @@ For a full command reference, see the list below, or visit [cli.netlify.com](htt ## Commands + ### [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) @@ -92,21 +92,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) @@ -124,31 +122,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) @@ -162,7 +157,6 @@ Unlink a local folder from a Netlify site Watch for site deploy to finish - ## Contributing diff --git a/docs/commands/addons.md b/docs/commands/addons.md index 076dd9cb76a..aa2abeb0738 100644 --- 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 + (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`](/commands/addons#addonsauth) | Login to add-on provider | -| [`addons:config`](/commands/addons#addonsconfig) | Configure add-on settings | -| [`addons:create`](/commands/addons#addonscreate) | Add an add-on extension to your site | -| [`addons:delete`](/commands/addons#addonsdelete) | Remove an add-on extension to your site | -| [`addons:list`](/commands/addons#addonslist) | List currently installed add-ons for site | - +| Subcommand | description | +| :----------------------------------------------- | :---------------------------------------- | +| [`addons:auth`](/commands/addons#addonsauth) | Login to add-on provider | +| [`addons:config`](/commands/addons#addonsconfig) | Configure add-on settings | +| [`addons:create`](/commands/addons#addonscreate) | Add an add-on extension to your site | +| [`addons:delete`](/commands/addons#addonsdelete) | Remove an add-on extension to your site | +| [`addons:list`](/commands/addons#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 index dcd6bcb69b3..740a84e8c45 100644 --- 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/) + 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"}' ``` - diff --git a/docs/commands/deploy.md b/docs/commands/deploy.md index 2027a43208b..91a9f2411df 100644 --- a/docs/commands/deploy.md +++ b/docs/commands/deploy.md @@ -5,6 +5,7 @@ title: Netlify CLI deploy command # `deploy` + 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,15 +77,15 @@ netlify deploy **Flags** -- `dir` (*option*) - Specify a folder to deploy -- `functions` (*option*) - Specify a functions folder to deploy -- `prod` (*boolean*) - Deploy to production -- `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 +- `dir` (_option_) - Specify a folder to deploy +- `functions` (_option_) - Specify a functions folder to deploy +- `prod` (_boolean_) - Deploy to production +- `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 **Examples** @@ -104,5 +97,4 @@ netlify deploy --message "A message with an $ENV_VAR" netlify deploy --auth $NETLIFY_AUTH_TOKEN ``` - diff --git a/docs/commands/dev.md b/docs/commands/dev.md index 1375fcf4a6a..f871af0f113 100644 --- a/docs/commands/dev.md +++ b/docs/commands/dev.md @@ -6,10 +6,10 @@ description: Run netlify dev locally # `dev` + Local dev server The dev command will run a local dev server with Netlify's proxy and redirect rules - **Usage** ```bash @@ -18,19 +18,18 @@ netlify dev **Flags** -- `command` (*option*) - command to run -- `port` (*option*) - port of netlify dev -- `functionsPort` (*option*) - port for functions server -- `targetPort` (*option*) - port of target app server -- `dir` (*option*) - dir with static files -- `functions` (*option*) - Specify a functions folder to serve -- `offline` (*boolean*) - disables any features that require network access -- `live` (*boolean*) - Start a public live session - -| Subcommand | description | -|:--------------------------- |:-----| -| [`dev:exec`](/commands/dev#devexec) | Exec command | +- `command` (_option_) - command to run +- `port` (_option_) - port of netlify dev +- `functionsPort` (_option_) - port for functions server +- `targetPort` (_option_) - port of target app server +- `dir` (_option_) - dir with static files +- `functions` (_option_) - Specify a functions folder to serve +- `offline` (_boolean_) - disables any features that require network access +- `live` (_boolean_) - Start a public live session +| Subcommand | description | +| :---------------------------------- | :----------- | +| [`dev:exec`](/commands/dev#devexec) | Exec command | **Examples** @@ -41,12 +40,12 @@ $ netlify dev -c hugo ``` --- + ## `dev:exec` Exec command Runs a command within the netlify dev environment, e.g. with env variables from any installed addons - **Usage** ```bash diff --git a/docs/commands/functions.md b/docs/commands/functions.md index ed549e1b3dd..09c6eee3e43 100644 --- a/docs/commands/functions.md +++ b/docs/commands/functions.md @@ -6,22 +6,21 @@ description: Run netlify dev locally # `functions` + Manage netlify functions The `functions` command will help you manage the functions in this site - **Usage** ```bash netlify functions ``` -| Subcommand | description | -|:--------------------------- |:-----| -| [`functions:build`](/commands/functions#functionsbuild) | build functions locally | -| [`functions:create`](/commands/functions#functionscreate) | create a new function locally | -| [`functions:invoke`](/commands/functions#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`](/commands/functions#functionsbuild) | build functions locally | +| [`functions:create`](/commands/functions#functionscreate) | create a new function locally | +| [`functions:invoke`](/commands/functions#functionsinvoke) | trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions | **Examples** @@ -31,11 +30,11 @@ netlify functions:build --name function-abc --timeout 30s ``` --- + ## `functions:build` build functions locally - **Usage** ```bash @@ -44,10 +43,11 @@ netlify functions:build **Flags** -- `functions` (*option*) - Specify a functions folder to build to -- `src` (*option*) - Specify the source folder for the functions +- `functions` (_option_) - Specify a functions folder to build to +- `src` (_option_) - Specify the source folder for the functions --- + ## `functions:create` create a new function locally @@ -64,8 +64,8 @@ netlify functions:create **Flags** -- `name` (*option*) - function name -- `url` (*option*) - pull template from URL +- `name` (_option_) - function name +- `url` (_option_) - pull template from URL **Examples** @@ -76,6 +76,7 @@ netlify functions:create --name hello-world ``` --- + ## `functions:invoke` trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions @@ -92,11 +93,11 @@ netlify functions:invoke **Flags** -- `name` (*option*) - function name to invoke -- `functions` (*option*) - Specify a functions folder to parse, overriding netlify.toml -- `querystring` (*option*) - Querystring to add to your function invocation -- `payload` (*option*) - Supply POST payload in stringified json, or a path to a json file -- `identity` (*boolean*) - simulate Netlify Identity authentication JWT. pass --no-identity to affirm unauthenticated request +- `name` (_option_) - function name to invoke +- `functions` (_option_) - Specify a functions folder to parse, overriding netlify.toml +- `querystring` (_option_) - Querystring to add to your function invocation +- `payload` (_option_) - Supply POST payload in stringified json, or a path to a json file +- `identity` (_boolean_) - simulate Netlify Identity authentication JWT. pass --no-identity to affirm unauthenticated request **Examples** diff --git a/docs/commands/index.md b/docs/commands/index.md index 14bdb163228..dc542f02e22 100644 --- a/docs/commands/index.md +++ b/docs/commands/index.md @@ -13,7 +13,6 @@ netlify help To get a list of available sub-commands, arguments & flags run - ``` netlify [command] help ``` @@ -21,18 +20,18 @@ netlify [command] help ## Commands + ### [addons](/commands/addons) (Beta) Manage Netlify Add-ons -| Subcommand | description | -|:--------------------------- |:-----| -| [`addons:auth`](/commands/addons#addonsauth) | Login to add-on provider | -| [`addons:config`](/commands/addons#addonsconfig) | Configure add-on settings | -| [`addons:create`](/commands/addons#addonscreate) | Add an add-on extension to your site | -| [`addons:delete`](/commands/addons#addonsdelete) | Remove an add-on extension to your site | -| [`addons:list`](/commands/addons#addonslist) | List currently installed add-ons for site | - +| Subcommand | description | +| :----------------------------------------------- | :---------------------------------------- | +| [`addons:auth`](/commands/addons#addonsauth) | Login to add-on provider | +| [`addons:config`](/commands/addons#addonsconfig) | Configure add-on settings | +| [`addons:create`](/commands/addons#addonscreate) | Add an add-on extension to your site | +| [`addons:delete`](/commands/addons#addonsdelete) | Remove an add-on extension to your site | +| [`addons:list`](/commands/addons#addonslist) | List currently installed add-ons for site | ### [api](/commands/api) @@ -46,21 +45,19 @@ Create a new deploy from the contents of a folder Local dev server -| Subcommand | description | -|:--------------------------- |:-----| -| [`dev:exec`](/commands/dev#devexec) | Exec command | - +| Subcommand | description | +| :---------------------------------- | :----------- | +| [`dev:exec`](/commands/dev#devexec) | Exec command | ### [functions](/commands/functions) Manage netlify functions -| Subcommand | description | -|:--------------------------- |:-----| -| [`functions:build`](/commands/functions#functionsbuild) | build functions locally | -| [`functions:create`](/commands/functions#functionscreate) | create a new function locally | -| [`functions:invoke`](/commands/functions#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`](/commands/functions#functionsbuild) | build functions locally | +| [`functions:create`](/commands/functions#functionscreate) | create a new function locally | +| [`functions:invoke`](/commands/functions#functionsinvoke) | trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions | ### [init](/commands/init) @@ -78,31 +75,28 @@ Login to your Netlify account Open settings for the site linked to the current folder -| Subcommand | description | -|:--------------------------- |:-----| -| [`open:admin`](/commands/open#openadmin) | Opens current site admin UI in Netlify | -| [`open:site`](/commands/open#opensite) | Opens current site url in browser | - +| Subcommand | description | +| :--------------------------------------- | :------------------------------------- | +| [`open:admin`](/commands/open#openadmin) | Opens current site admin UI in Netlify | +| [`open:site`](/commands/open#opensite) | Opens current site url in browser | ### [sites](/commands/sites) Handle various site operations -| Subcommand | description | -|:--------------------------- |:-----| -| [`sites:create`](/commands/sites#sitescreate) | Create an empty site (advanced) | -| [`sites:delete`](/commands/sites#sitesdelete) | Delete a site | -| [`sites:list`](/commands/sites#siteslist) | List all sites you have access to | - +| Subcommand | description | +| :-------------------------------------------- | :-------------------------------- | +| [`sites:create`](/commands/sites#sitescreate) | Create an empty site (advanced) | +| [`sites:delete`](/commands/sites#sitesdelete) | Delete a site | +| [`sites:list`](/commands/sites#siteslist) | List all sites you have access to | ### [status](/commands/status) Print status information -| Subcommand | description | -|:--------------------------- |:-----| -| [`status:hooks`](/commands/status#statushooks) | Print hook information of the linked site | - +| Subcommand | description | +| :--------------------------------------------- | :---------------------------------------- | +| [`status:hooks`](/commands/status#statushooks) | Print hook information of the linked site | ### [switch](/commands/switch) @@ -116,5 +110,4 @@ Unlink a local folder from a Netlify site Watch for site deploy to finish - diff --git a/docs/commands/init.md b/docs/commands/init.md index cacf4d1e0b6..c67dcc76816 100644 --- a/docs/commands/init.md +++ b/docs/commands/init.md @@ -6,6 +6,7 @@ description: Initialize a new site locally # `init` + Configure continuous deployment for a new or existing site **Usage** @@ -16,9 +17,8 @@ netlify init **Flags** -- `manual` (*boolean*) - Manually configure a git remote for CI -- `watch` (*boolean*) - Make the CLI wait for the first deploy to complete after setting up CI -- `force` (*boolean*) - Reinitialize CI hooks if the linked site is already configured to use CI - +- `manual` (_boolean_) - Manually configure a git remote for CI +- `watch` (_boolean_) - Make the CLI wait for the first deploy to complete after setting up CI +- `force` (_boolean_) - Reinitialize CI hooks if the linked site is already configured to use CI diff --git a/docs/commands/link.md b/docs/commands/link.md index c88a9171fea..9464c638001 100644 --- a/docs/commands/link.md +++ b/docs/commands/link.md @@ -6,6 +6,7 @@ description: Link an existing site to a local site directory # `link` + Link a local repo or project folder to an existing site on Netlify **Usage** @@ -16,8 +17,8 @@ netlify link **Flags** -- `id` (*option*) - ID of site to link to -- `name` (*option*) - Name of site to link to +- `id` (_option_) - ID of site to link to +- `name` (_option_) - Name of site to link to **Examples** @@ -27,5 +28,4 @@ netlify link --id 123-123-123-123 netlify link --name my-site-name ``` - diff --git a/docs/commands/login.md b/docs/commands/login.md index e1e37a8cd0b..93b7922c058 100644 --- a/docs/commands/login.md +++ b/docs/commands/login.md @@ -6,11 +6,11 @@ description: Login to your Netlify account # `login` + Login to your Netlify account Opens a web browser to acquire an OAuth token. - **Usage** ```bash @@ -19,7 +19,6 @@ netlify login **Flags** -- `new` (*boolean*) - Login to new Netlify account - +- `new` (_boolean_) - Login to new Netlify account diff --git a/docs/commands/logout.md b/docs/commands/logout.md index 582f650b4d3..a8e2eecbd5d 100644 --- a/docs/commands/logout.md +++ b/docs/commands/logout.md @@ -7,6 +7,7 @@ hidden: true # `logout` + Logout of your Netlify account **Usage** @@ -14,4 +15,5 @@ Logout of your Netlify account ```bash netlify logout ``` + diff --git a/docs/commands/open.md b/docs/commands/open.md index eec9eb8d0ed..5df7b87a150 100644 --- a/docs/commands/open.md +++ b/docs/commands/open.md @@ -5,6 +5,7 @@ title: Netlify CLI open command # `open` + Open settings for the site linked to the current folder **Usage** @@ -15,14 +16,13 @@ netlify open **Flags** -- `site` (*boolean*) - Open site -- `admin` (*boolean*) - Open Netlify site - -| Subcommand | description | -|:--------------------------- |:-----| -| [`open:admin`](/commands/open#openadmin) | Opens current site admin UI in Netlify | -| [`open:site`](/commands/open#opensite) | Opens current site url in browser | +- `site` (_boolean_) - Open site +- `admin` (_boolean_) - Open Netlify site +| Subcommand | description | +| :--------------------------------------- | :------------------------------------- | +| [`open:admin`](/commands/open#openadmin) | Opens current site admin UI in Netlify | +| [`open:site`](/commands/open#opensite) | Opens current site url in browser | **Examples** @@ -34,6 +34,7 @@ netlify open:site ``` --- + ## `open:admin` Opens current site admin UI in Netlify @@ -51,6 +52,7 @@ netlify open:admin ``` --- + ## `open:site` Opens current site url in browser diff --git a/docs/commands/sites.md b/docs/commands/sites.md index 55effbef42e..6afc9fa13f5 100644 --- a/docs/commands/sites.md +++ b/docs/commands/sites.md @@ -6,22 +6,21 @@ description: Manage Netlify sites via the command line # `sites` + Handle various site operations The sites command will help you manage all your sites - **Usage** ```bash netlify sites ``` -| Subcommand | description | -|:--------------------------- |:-----| -| [`sites:create`](/commands/sites#sitescreate) | Create an empty site (advanced) | -| [`sites:delete`](/commands/sites#sitesdelete) | Delete a site | -| [`sites:list`](/commands/sites#siteslist) | List all sites you have access to | - +| Subcommand | description | +| :-------------------------------------------- | :-------------------------------- | +| [`sites:create`](/commands/sites#sitescreate) | Create an empty site (advanced) | +| [`sites:delete`](/commands/sites#sitesdelete) | Delete a site | +| [`sites:list`](/commands/sites#siteslist) | List all sites you have access to | **Examples** @@ -31,12 +30,12 @@ netlify sites:list ``` --- + ## `sites:create` Create an empty site (advanced) -Create a blank site that isn't associated with any git remote. Does not link to the current working directory. - +Create a blank site that isn't associated with any git remote. Does not link to the current working directory. **Usage** @@ -46,19 +45,19 @@ netlify sites:create **Flags** -- `name` (*option*) - name of site -- `account-slug` (*option*) - account slug to create the site under -- `with-ci` (*boolean*) - initialize CI hooks during site creation -- `manual` (*boolean*) - Force manual CI setup. Used --with-ci flag +- `name` (_option_) - name of site +- `account-slug` (_option_) - account slug to create the site under +- `with-ci` (_boolean_) - initialize CI hooks during site creation +- `manual` (_boolean_) - Force manual CI setup. Used --with-ci flag --- + ## `sites:delete` Delete a site This command will permanently delete the site on Netlify. Use with caution. - **Usage** ```bash @@ -71,7 +70,7 @@ netlify sites:delete {site-id} **Flags** -- `force` (*boolean*) - delete without prompting (useful for CI) +- `force` (_boolean_) - delete without prompting (useful for CI) **Examples** @@ -80,6 +79,7 @@ netlify site:delete 1234-3262-1211 ``` --- + ## `sites:list` List all sites you have access to @@ -92,7 +92,7 @@ netlify sites:list **Flags** -- `json` (*boolean*) - Output site data as JSON +- `json` (_boolean_) - Output site data as JSON --- diff --git a/docs/commands/status.md b/docs/commands/status.md index 076c685d4fe..c0ca6cee0fc 100644 --- a/docs/commands/status.md +++ b/docs/commands/status.md @@ -6,6 +6,7 @@ description: Get the current context of the netlify CLI # `status` + Print status information **Usage** @@ -16,14 +17,14 @@ netlify status **Flags** -- `verbose` (*boolean*) - Output system info - -| Subcommand | description | -|:--------------------------- |:-----| -| [`status:hooks`](/commands/status#statushooks) | Print hook information of the linked site | +- `verbose` (_boolean_) - Output system info +| Subcommand | description | +| :--------------------------------------------- | :---------------------------------------- | +| [`status:hooks`](/commands/status#statushooks) | Print hook information of the linked site | --- + ## `status:hooks` Print hook information of the linked site diff --git a/docs/commands/unlink.md b/docs/commands/unlink.md index ee7a2818907..0777512686c 100644 --- a/docs/commands/unlink.md +++ b/docs/commands/unlink.md @@ -6,6 +6,7 @@ description: Link an existing site to a local site directory # `unlink` + Unlink a local folder from a Netlify site **Usage** @@ -14,5 +15,4 @@ Unlink a local folder from a Netlify site netlify unlink ``` - diff --git a/docs/commands/watch.md b/docs/commands/watch.md index 2a6bbaa544b..014dedb4c4e 100644 --- a/docs/commands/watch.md +++ b/docs/commands/watch.md @@ -6,6 +6,7 @@ hidden: true # `watch` + Watch for site deploy to finish **Usage** @@ -21,5 +22,4 @@ netlify watch git push && netlify watch ``` - diff --git a/docs/getting-started.md b/docs/getting-started.md index 7382511a0da..0d375e0956c 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -12,27 +12,25 @@ Lets get rolling with the Netlify CLI. 1. **Install the CLI locally** - ```bash - npm install netlify-cli -g - ``` + ```bash + npm install netlify-cli -g + ``` 2. **Login to your Netlify Account** - ```bash - netlify login - ``` + ```bash + netlify login + ``` - If you are new to Netlify, you can [create an account here](https://app.netlify.com/). + If you are new to Netlify, you can [create an account here](https://app.netlify.com/). +3) **Initialize a new site** -3. **Initialize a new site** - - Inside of your sites `cwd`, run the following CLI command: - - ```bash - netlify init - ``` + Inside of your sites `cwd`, run the following CLI command: + ```bash + netlify init + ``` ## Link an existing site diff --git a/docs/index.md b/docs/index.md index acc55cd299f..3d23e710596 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,7 +5,7 @@ description: All Netlify CLI commands # Netlify CLI Command List -Welcome to the Netlify CLI! This site provides online access to all help strings in the Netlify CLI. For a more in-depth guide, please see our [Getting Started](https://www.netlify.com/docs/cli/) guide on our main docs site. +Welcome to the Netlify CLI! This site provides online access to all help strings in the Netlify CLI. For a more in-depth guide, please see our [Getting Started](https://www.netlify.com/docs/cli/) guide on our main docs site. If you have questions, ideas, or would like to contribute, check out the [repository on Github](https://github.com/netlify/cli/). @@ -27,7 +27,6 @@ netlify help To get a list of available sub-commands, arguments, and flags, run: - ``` netlify [command] help ``` @@ -35,18 +34,18 @@ netlify [command] help ## Commands + ### [addons](/commands/addons) (Beta) Manage Netlify Add-ons -| Subcommand | description | -|:--------------------------- |:-----| -| [`addons:auth`](/commands/addons#addonsauth) | Login to add-on provider | -| [`addons:config`](/commands/addons#addonsconfig) | Configure add-on settings | -| [`addons:create`](/commands/addons#addonscreate) | Add an add-on extension to your site | -| [`addons:delete`](/commands/addons#addonsdelete) | Remove an add-on extension to your site | -| [`addons:list`](/commands/addons#addonslist) | List currently installed add-ons for site | - +| Subcommand | description | +| :----------------------------------------------- | :---------------------------------------- | +| [`addons:auth`](/commands/addons#addonsauth) | Login to add-on provider | +| [`addons:config`](/commands/addons#addonsconfig) | Configure add-on settings | +| [`addons:create`](/commands/addons#addonscreate) | Add an add-on extension to your site | +| [`addons:delete`](/commands/addons#addonsdelete) | Remove an add-on extension to your site | +| [`addons:list`](/commands/addons#addonslist) | List currently installed add-ons for site | ### [api](/commands/api) @@ -60,21 +59,19 @@ Create a new deploy from the contents of a folder Local dev server -| Subcommand | description | -|:--------------------------- |:-----| -| [`dev:exec`](/commands/dev#devexec) | Exec command | - +| Subcommand | description | +| :---------------------------------- | :----------- | +| [`dev:exec`](/commands/dev#devexec) | Exec command | ### [functions](/commands/functions) Manage netlify functions -| Subcommand | description | -|:--------------------------- |:-----| -| [`functions:build`](/commands/functions#functionsbuild) | build functions locally | -| [`functions:create`](/commands/functions#functionscreate) | create a new function locally | -| [`functions:invoke`](/commands/functions#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`](/commands/functions#functionsbuild) | build functions locally | +| [`functions:create`](/commands/functions#functionscreate) | create a new function locally | +| [`functions:invoke`](/commands/functions#functionsinvoke) | trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions | ### [init](/commands/init) @@ -92,31 +89,28 @@ Login to your Netlify account Open settings for the site linked to the current folder -| Subcommand | description | -|:--------------------------- |:-----| -| [`open:admin`](/commands/open#openadmin) | Opens current site admin UI in Netlify | -| [`open:site`](/commands/open#opensite) | Opens current site url in browser | - +| Subcommand | description | +| :--------------------------------------- | :------------------------------------- | +| [`open:admin`](/commands/open#openadmin) | Opens current site admin UI in Netlify | +| [`open:site`](/commands/open#opensite) | Opens current site url in browser | ### [sites](/commands/sites) Handle various site operations -| Subcommand | description | -|:--------------------------- |:-----| -| [`sites:create`](/commands/sites#sitescreate) | Create an empty site (advanced) | -| [`sites:delete`](/commands/sites#sitesdelete) | Delete a site | -| [`sites:list`](/commands/sites#siteslist) | List all sites you have access to | - +| Subcommand | description | +| :-------------------------------------------- | :-------------------------------- | +| [`sites:create`](/commands/sites#sitescreate) | Create an empty site (advanced) | +| [`sites:delete`](/commands/sites#sitesdelete) | Delete a site | +| [`sites:list`](/commands/sites#siteslist) | List all sites you have access to | ### [status](/commands/status) Print status information -| Subcommand | description | -|:--------------------------- |:-----| -| [`status:hooks`](/commands/status#statushooks) | Print hook information of the linked site | - +| Subcommand | description | +| :--------------------------------------------- | :---------------------------------------- | +| [`status:hooks`](/commands/status#statushooks) | Print hook information of the linked site | ### [switch](/commands/switch) @@ -130,5 +124,4 @@ Unlink a local folder from a Netlify site Watch for site deploy to finish - diff --git a/docs/netlify-dev.md b/docs/netlify-dev.md index 754871e7c80..42a59b8d781 100644 --- a/docs/netlify-dev.md +++ b/docs/netlify-dev.md @@ -225,14 +225,14 @@ Function templates can specify `addons` that they rely on as well as execute arb module.exports = { addons: [ { - addonName: "fauna", + addonName: 'fauna', addonDidInstall: () => {} // post install function to run after installing addon, eg. for setting up schema } ], onComplete() { - console.log(`custom-template function created from template!`); + console.log(`custom-template function created from template!`) } -}; +} ``` Instead of using our basic templates, you can use your own by passing it with a --url flag: `netlify functions:create hello-world --url https://github.com/netlify-labs/all-the-functions/tree/master/functions/9-using-middleware`, specifying any addons and postinstall/complete steps as shown above. @@ -266,7 +266,6 @@ There are special cases for [event triggered functions](https://www.netlify.com/ This is a new feature; ideas and feedback and issues and PR's welcome! - ### Function Builders, Function Builder Detection, and Relationship with `netlify-lambda` **Existing users of `netlify-lambda` should have no change to their workflow by switching to `netlify dev`.** One immediate benefit is no need for [proxying](https://github.com/netlify/netlify-lambda#proxying-for-local-development) since Netlify Dev does that for you. diff --git a/layout.html b/layout.html index 58ad39b9590..601e33be959 100644 --- a/layout.html +++ b/layout.html @@ -1,29 +1,27 @@ + + + + netlify-cli + + + + + - - - - netlify-cli - - - - - - - - -
- - + + +
+ diff --git a/package.json b/package.json index 532e6b2f532..9aa4ac3358d 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "ava": "ava --verbose", "test:ava": "nyc --reporter=lcov ava --verbose && nyc report", "test:lint": "eslint --fix \"{src,scripts}/**/*.js\"", - "test:prettier": "prettier --write --loglevel warn \"src/**/*.js\" \"*.{js,md,yml,json}\"", + "test:prettier": "prettier --write --loglevel warn \"{src,scripts,docs,site/src,.circleci,.github}/**/*.{js,md,yml,json,html}\" \"site/*.{js,md}\" \"*.{js,md,yml,json,html}\"", "test:cli-version": "npm run start -- --version", "test:cli-help": "npm run start -- --help", "watch": "nyc --reporter=lcov ava --watch", diff --git a/scripts/algolia.js b/scripts/algolia.js index d11093f4a69..cfce7b575aa 100644 --- a/scripts/algolia.js +++ b/scripts/algolia.js @@ -16,7 +16,6 @@ const algoliaClient = algoliaSearch(algoliaApplicationID, ALGOLIA_API_KEY) // Get CLI command data const commandData = generateCommandData() - const flattenedData = Object.keys(commandData).reduce((acc, curr) => { const command = commandData[curr] if (command.commands.length) { @@ -37,7 +36,6 @@ const flattenedData = Object.keys(commandData).reduce((acc, curr) => { return acc }, {}) - /* function getCommandData(commandData) { return Object.keys(commandData).reduce((a, c) => { @@ -56,12 +54,12 @@ function getCommandData(commandData) { // console.log('flattenedData', flattenedData) // console.log('commandData', commandData) -const algoliaData = Object.keys(flattenedData).map((key) => { +const algoliaData = Object.keys(flattenedData).map(key => { const command = flattenedData[key] // delete command.commands const data = Object.assign({}, command, { - objectID: key, + objectID: key }) return data diff --git a/site/src/_app.js b/site/src/_app.js index 62df8dea4f2..9c8d0dcce81 100644 --- a/site/src/_app.js +++ b/site/src/_app.js @@ -23,7 +23,7 @@ const scope = { ) } return ( - + {children} ) @@ -34,56 +34,56 @@ const navOrder = [ 'index', 'getting-started', 'commands', - "addons", - "api", - "deploy", - "dev", - "functions", - "init", - "link", - "login", - "logout", - "open", - "sites", - "status", - "unlink", + 'addons', + 'api', + 'deploy', + 'dev', + 'functions', + 'init', + 'link', + 'login', + 'logout', + 'open', + 'sites', + 'status', + 'unlink', 'netlify-dev', - 'contributing', + 'contributing' ] const pageNames = { index: 'Introduction', 'getting-started': 'Getting Started', - 'commands': 'CLI Commands', - 'contributing': 'Contributing', - 'netlify-dev': 'Netlify Dev', + commands: 'CLI Commands', + contributing: 'Contributing', + 'netlify-dev': 'Netlify Dev' } -const sortRoutes = routes => [ - ...sortBy([...routes], a => { - const i = navOrder.indexOf(a.name) - return i < 0 ? Infinity : i - }) -].map(route => { - if (!pageNames[route.name]) { - return route - } - return { - ...route, - name: pageNames[route.name], - props: { - hidePagination: true +const sortRoutes = routes => + [ + ...sortBy([...routes], a => { + const i = navOrder.indexOf(a.name) + return i < 0 ? Infinity : i + }) + ].map(route => { + if (!pageNames[route.name]) { + return route } - } -}) + return { + ...route, + name: pageNames[route.name], + props: { + hidePagination: true + } + } + }) export default class App extends React.Component { - static defaultProps = { title: 'Netlify CLI' } - render () { + render() { const { routes } = this.props const nav = sortRoutes(routes) diff --git a/site/src/_layout.js b/site/src/_layout.js index dac739be543..91a170b75a0 100644 --- a/site/src/_layout.js +++ b/site/src/_layout.js @@ -1,9 +1,6 @@ import React from 'react' import PropTypes from 'prop-types' -import { - Link as RouterLink, - NavLink as RouterNavLink -} from 'react-router-dom' +import { Link as RouterLink, NavLink as RouterNavLink } from 'react-router-dom' import { Helmet } from 'react-helmet' import styled, { injectGlobal } from 'styled-components' import { @@ -20,7 +17,7 @@ import { NavLink, BlockLink, Button, - ButtonTransparent, + ButtonTransparent } from 'rebass' import { InstantSearch, Hits, SearchBox, createConnector, Configure, Highlight } from 'react-instantsearch-dom' import { borderColor, themeGet } from 'styled-system' @@ -47,27 +44,32 @@ export const Root = styled.div` margin-bottom: 15px; line-height: 26px; } -`; - -export const Sidebar = styled('div')([], { - width: '256px', - height: '100vh', - flex: 'none', - overflowY: 'auto', - WebkitOverflowScrolling: 'touch', - transition: 'transform .2s ease-out', - backgroundColor: '#fff', - borderRight: '1px solid', - position: 'fixed', - top: 0, - left: 0, - bottom: 0, -}, props => ({ - transform: props.open ? 'translateX(0)' : 'translateX(-100%)', - [breakpoint]: { - transform: 'none' - } -}), borderColor) +` + +export const Sidebar = styled('div')( + [], + { + width: '256px', + height: '100vh', + flex: 'none', + overflowY: 'auto', + WebkitOverflowScrolling: 'touch', + transition: 'transform .2s ease-out', + backgroundColor: '#fff', + borderRight: '1px solid', + position: 'fixed', + top: 0, + left: 0, + bottom: 0 + }, + props => ({ + transform: props.open ? 'translateX(0)' : 'translateX(-100%)', + [breakpoint]: { + transform: 'none' + } + }), + borderColor +) Sidebar.defaultProps = { borderColor: 'gray' } @@ -77,30 +79,23 @@ export const Overlay = styled('div')([], { top: 0, right: 0, bottom: 0, - left: 0, + left: 0 }) export const MobileOnly = styled.div([], { [breakpoint]: { display: 'none' - }, + } }) export const MenuIcon = ({ size = 24, ...props }) => { return ( - - + + ) } - const LogoContainer = styled.span` svg { width: 130px; @@ -108,27 +103,51 @@ const LogoContainer = styled.span` display: flex; align-items: center; color: rgb(14, 30, 37); -`; +` const NetlifyLogo = () => { return ( - - - + + + - - - - - - - - + + + + + + + + - ) } @@ -136,28 +155,14 @@ const NetlifyLogo = () => { const GithubIcon = () => { return ( - + ) } -export const Main = props => - - -export const MaxWidth = props => - +export const Main = props => + +export const MaxWidth = props => export const Content = styled(Box)([], { minHeight: 'calc(100vh - 208px)' @@ -167,35 +172,33 @@ export const UL = styled('ul')([], { listStyle: 'none', margin: 0, paddingLeft: 0, - paddingBottom: '48px', + paddingBottom: '48px' }) -export const LI = styled('li')([], { -}) +export const LI = styled('li')([], {}) const depthPad = ({ to = '' }) => - (1 + to.split('/') - .filter(s => s.length) - .slice(1).length) * 16 - -const Link = styled(props => ( - -))([], props => ({ - borderLeft: '4px solid', - borderColor: 'transparent', - '&.active, &:focus': { - color: '#00c2b2', //'#00ad9f', // themeGet('colors.blue', '#07c')(props), - outline: 'none', - }, - '&:focus': { - borderColor: 'inherit', - } -})) + (1 + + to + .split('/') + .filter(s => s.length) + .slice(1).length) * + 16 + +const Link = styled(props => )( + [], + props => ({ + borderLeft: '4px solid', + borderColor: 'transparent', + '&.active, &:focus': { + color: '#00c2b2', //'#00ad9f', // themeGet('colors.blue', '#07c')(props), + outline: 'none' + }, + '&:focus': { + borderColor: 'inherit' + } + }) +) Link.defaultProps = { to: '' @@ -207,33 +210,23 @@ const upperFirst = str => str.charAt(0).toUpperCase() + str.slice(1) return upperFirst(unhyphenate(str)) }*/ const format = (str, data) => { - if (data && data.path && data.path.match((/commands/)) && str !== 'commands') { + if (data && data.path && data.path.match(/commands/) && str !== 'commands') { return {str} } return str } -const NavBar = ({ - title, - logo, - focus, - update, -}) => - +const NavBar = ({ title, logo, focus, update }) => ( + {logo} - - + + - + - +) const EditLink = styled.div` a { @@ -254,8 +247,7 @@ const EditLink = styled.div` right: 25px; top: 70px; } -`; - +` const SearchBoxWrapper = styled.div` padding-left: 10px; @@ -275,14 +267,14 @@ const SearchBoxWrapper = styled.div` @media (max-width: 815px) { display: none; } -`; +` const HitBoxWrapper = styled.div` position: fixed; - top:100px; - left:5px; + top: 100px; + left: 5px; background: white; - box-shadow: 0 6px 34px rgba(83,40,255,.15); + box-shadow: 0 6px 34px rgba(83, 40, 255, 0.15); .ais-Highlight-highlighted { background: yellow; } @@ -293,16 +285,15 @@ const HitBoxWrapper = styled.div` @media (max-width: 815px) { width: 100%; } -`; +` const SearchWrapper = styled.div` .ais-Highlight-highlighted { background: blue; } -`; - +` -const Result = (props) => { +const Result = props => { // console.log(props) return
{props.hit.firstname}
} @@ -310,23 +301,22 @@ const Result = (props) => { const HitsOverlay = styled.div` padding: 20px; background-color: #fff; -`; +` const MyHits = createConnector({ - displayName: "ConditionalQuery", + displayName: 'ConditionalQuery', getProvidedProps(props, searchState, searchResults) { - const { query, hits } = searchResults.results ? searchResults.results : {}; - return { query, hits }; + const { query, hits } = searchResults.results ? searchResults.results : {} + return { query, hits } } })(({ query, hits }) => { - if (hits && query) { return hits.map((hit, i) => { const slug = hit.name.replace(/:/g, '') return ( - + @@ -336,22 +326,16 @@ const MyHits = createConnector({ }) } - return null; -}); - - + return null +}) -export const Nav = ({ - routes = [], - searchRender, - ...props -}) => +export const Nav = ({ routes = [], searchRender, ...props }) => ( - { /* searchRender */ } + {/* searchRender */}
    {routes.map(route => { @@ -359,7 +343,8 @@ export const Nav = ({ if (route.module && route.module.frontMatter && route.module.frontMatter.hidden) { return null } - return (
  • + return ( +
  • {/^https?:\/\//.test(route.path) ? ( {route.name} @@ -370,71 +355,57 @@ export const Nav = ({ )}
    • - )} - )} + ) + })}
+) -export const Pagination = ({ previous, next }) => - +export const Pagination = ({ previous, next }) => ( + {previous && ( - + Previous: - + {format(previous.name)} )} - + {next && ( - + Next: - + {format(next.name)} )} +) -const MobileNav = ({ - title, - logo, - update -}) => +const MobileNav = ({ title, logo, update }) => ( - + update(toggle('menu'))} > {logo || } - - {title} - - + {title} + +) const toggle = key => state => ({ [key]: !state[key] }) const close = state => ({ menu: false }) - export default class Layout extends React.Component { static propTypes = { routes: PropTypes.array.isRequired @@ -445,14 +416,8 @@ export default class Layout extends React.Component { update: fn => this.setState(fn) } - render () { - const { - routes = [], - children, - route, - title = 'Netlify CLI', - logo, - } = this.props + render() { + const { routes = [], children, route, title = 'Netlify CLI', logo } = this.props const { menu, update } = this.state @@ -484,43 +449,33 @@ export default class Layout extends React.Component { return ( - {pageTitle} - + {menu && update(close)} />} - + - update(close)}> + update(close)}>