diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 11e2af0eab56b..0000000000000 --- a/docs/README.md +++ /dev/null @@ -1,97 +0,0 @@ - -

- - Gatsby - -

-

- Gatsby's default starter -

- -Kick off your project with this default boilerplate. This starter ships with the main Gatsby configuration files you might need to get up and running blazing fast with the blazing fast app generator for React. - -_Have another more specific idea? You may want to check out our vibrant collection of [official and community-created starters](https://www.gatsbyjs.org/docs/gatsby-starters/)._ - -## πŸš€ Quick start - -1. **Create a Gatsby site.** - - Use the Gatsby CLI to create a new site, specifying the default starter. - - ```sh - # create a new Gatsby site using the default starter - gatsby new my-default-starter https://github.com/gatsbyjs/gatsby-starter-default - ``` - -1. **Start developing.** - - Navigate into your new site’s directory and start it up. - - ```sh - cd my-default-starter/ - gatsby develop - ``` - -1. **Open the source code and start editing!** - - Your site is now running at `http://localhost:8000`! - - _Note: You'll also see a second link: _`http://localhost:8000/___graphql`_. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the [Gatsby tutorial](https://www.gatsbyjs.org/tutorial/part-five/#introducing-graphiql)._ - - Open the `my-default-starter` directory in your code editor of choice and edit `src/pages/index.js`. Save your changes and the browser will update in real time! - -## 🧐 What's inside? - -A quick look at the top-level files and directories you'll see in a Gatsby project. - - . - β”œβ”€β”€ node_modules - β”œβ”€β”€ src - β”œβ”€β”€ .gitignore - β”œβ”€β”€ .prettierrc - β”œβ”€β”€ gatsby-browser.js - β”œβ”€β”€ gatsby-config.js - β”œβ”€β”€ gatsby-node.js - β”œβ”€β”€ gatsby-ssr.js - β”œβ”€β”€ LICENSE - β”œβ”€β”€ package-lock.json - β”œβ”€β”€ package.json - └── README.md - -1. **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed. - -2. **`/src`**: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. `src` is a convention for β€œsource code”. - -3. **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for. - -4. **`.prettierrc`**: This is a configuration file for [Prettier](https://prettier.io/). Prettier is a tool to help keep the formatting of your code consistent. - -5. **`gatsby-browser.js`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://www.gatsbyjs.org/docs/browser-apis/) (if any). These allow customization/extension of default Gatsby settings affecting the browser. - -6. **`gatsby-config.js`**: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the [config docs](https://www.gatsbyjs.org/docs/gatsby-config/) for more detail). - -7. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.org/docs/node-apis/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process. - -8. **`gatsby-ssr.js`**: This file is where Gatsby expects to find any usage of the [Gatsby server-side rendering APIs](https://www.gatsbyjs.org/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering. - -9. **`LICENSE`**: Gatsby is licensed under the MIT license. - -10. **`package-lock.json`** (See `package.json` below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. **(You won’t change this file directly).** - -11. **`package.json`**: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project. - -12. **`README.md`**: A text file containing useful reference information about your project. - -## πŸŽ“ Learning Gatsby - -Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start: - -- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.org/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process. - -- **To dive straight into code samples, head [to our documentation](https://www.gatsbyjs.org/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar. - -## πŸ’« Deploy - -[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/gatsbyjs/gatsby-starter-default) - - diff --git a/docs/content/cli-commands/npm-access.md b/docs/content/cli-commands/npm-access.md index 99a639a84b739..f2411af26e761 100755 --- a/docs/content/cli-commands/npm-access.md +++ b/docs/content/cli-commands/npm-access.md @@ -87,7 +87,7 @@ Management of teams and team memberships is done with the `npm team` command. ### See Also * [`libnpmaccess`](https://npm.im/libnpmaccess) -* [npm-team](/cli-commands/npm-team) -* [npm-publish](/cli-commands/npm-publish) -* [npm-config](/cli-commands/npm-config) -* [npm-registry](/using-npm/registry) +* [npm team](/cli-commands/npm-team) +* [npm publish](/cli-commands/npm-publish) +* [npm config](/cli-commands/npm-config) +* [npm registry](/using-npm/registry) diff --git a/docs/content/cli-commands/npm-adduser.md b/docs/content/cli-commands/npm-adduser.md index d3277b95ca1a9..0a549005f1e3a 100755 --- a/docs/content/cli-commands/npm-adduser.md +++ b/docs/content/cli-commands/npm-adduser.md @@ -1,4 +1,4 @@ ---- + --- section: cli-commands title: npm-adduser description: Set access level on published packages @@ -90,8 +90,8 @@ username/password entry in legacy npm. ### See Also -* [npm-registry](/using-npm/registry) -* [npm-config](/cli-commands/npm-config) +* [npm registry](/using-npm/registry) +* [npm config](/cli-commands/npm-config) * [npmrc](/configuring-npm/npmrc) -* [npm-owner](/cli-commands/npm-owner) -* [npm-whoami](/cli-commands/npm-whoami) +* [npm owner](/cli-commands/npm-owner) +* [npm whoami](/cli-commands/npm-whoami) diff --git a/docs/content/cli-commands/npm-audit.md b/docs/content/cli-commands/npm-audit.md index 0e656e5020bc7..8e488614142d0 100755 --- a/docs/content/cli-commands/npm-audit.md +++ b/docs/content/cli-commands/npm-audit.md @@ -131,6 +131,6 @@ configuration setting. ### See Also -* [npm-install](/cli-commands/npm-install) +* [npm install](/cli-commands/npm-install) * [package-locks](/configuring-npm/package-locks) * [config](/using-npm/config) diff --git a/docs/content/cli-commands/npm-bin.md b/docs/content/cli-commands/npm-bin.md index 9cb89b026b4a3..b612ea3cfe8c3 100755 --- a/docs/content/cli-commands/npm-bin.md +++ b/docs/content/cli-commands/npm-bin.md @@ -19,8 +19,8 @@ Print the folder where npm will install executables. ### See Also -* [npm-prefix](/cli-commands/npm-prefix) -* [npm-root](/cli-commands/npm-root) -* [npm-folders](/configuring-npm/folders) -* [npm-config](/cli-commands/npm-config) +* [npm prefix](/cli-commands/npm-prefix) +* [npm root](/cli-commands/npm-root) +* [npm folders](/configuring-npm/folders) +* [npm config](/cli-commands/npm-config) * [npmrc](/configuring-npm/npmrc) diff --git a/docs/content/cli-commands/npm-bugs.md b/docs/content/cli-commands/npm-bugs.md index 6a3ccba356a12..46a3505808deb 100755 --- a/docs/content/cli-commands/npm-bugs.md +++ b/docs/content/cli-commands/npm-bugs.md @@ -41,10 +41,10 @@ The base URL of the npm package registry. ### See Also -* [npm-docs](/cli-commands/npm-docs) -* [npm-view](/cli-commands/npm-view) -* [npm-publish](/cli-commands/npm-publish) -* [npm-registry](/using-npm/registry) -* [npm-config](/cli-commands/npm-config) +* [npm docs](/cli-commands/npm-docs) +* [npm view](/cli-commands/npm-view) +* [npm publish](/cli-commands/npm-publish) +* [npm registry](/using-npm/registry) +* [npm config](/cli-commands/npm-config) * [npmrc](/configuring-npm/npmrc) * [package.json](/configuring-npm/package-json) diff --git a/docs/content/cli-commands/npm-build.md b/docs/content/cli-commands/npm-build.md index 045df9387d362..7d599b0a4b06d 100755 --- a/docs/content/cli-commands/npm-build.md +++ b/docs/content/cli-commands/npm-build.md @@ -28,7 +28,7 @@ directly, run: ### See Also -* [npm-install](/cli-commands/npm-install) -* [npm-link](/cli-commands/npm-link) -* [npm-scripts](/using-npm/scripts) +* [npm install](/cli-commands/npm-install) +* [npm link](/cli-commands/npm-link) +* [npm scripts](/using-npm/scripts) * [package.json](/configuring-npm/package-json) diff --git a/docs/content/cli-commands/npm-bundle.md b/docs/content/cli-commands/npm-bundle.md index 038967d9937ca..8de9dc15c2d61 100755 --- a/docs/content/cli-commands/npm-bundle.md +++ b/docs/content/cli-commands/npm-bundle.md @@ -18,4 +18,4 @@ Just use `npm install` now to do what `npm bundle` used to do. ### See Also -* [npm-install](/cli-commands/npm-install) +* [npm install](/cli-commands/npm-install) diff --git a/docs/content/cli-commands/npm-cache.md b/docs/content/cli-commands/npm-cache.md index ad23198e07845..143cd9285b881 100755 --- a/docs/content/cli-commands/npm-cache.md +++ b/docs/content/cli-commands/npm-cache.md @@ -81,11 +81,11 @@ The root cache folder. ### See Also -* [npm-folders](/configuring-npm/folders) -* [npm-config](/cli-commands/npm-config) +* [npm folders](/configuring-npm/folders) +* [npm config](/cli-commands/npm-config) * [npmrc](/configuring-npm/npmrc) -* [npm-install](/cli-commands/npm-install) -* [npm-publish](/cli-commands/npm-publish) -* [npm-pack](/cli-commands/npm-pack) +* [npm install](/cli-commands/npm-install) +* [npm publish](/cli-commands/npm-publish) +* [npm pack](/cli-commands/npm-pack) * https://npm.im/cacache * https://npm.im/pacote diff --git a/docs/content/cli-commands/npm-ci.md b/docs/content/cli-commands/npm-ci.md index 1a00c77f55c89..88d12a7e6aa15 100755 --- a/docs/content/cli-commands/npm-ci.md +++ b/docs/content/cli-commands/npm-ci.md @@ -63,5 +63,5 @@ In short, the main differences between using `npm install` and `npm ci` are: ### See Also -* [npm-install](/cli-commands/npm-install) -* [npm-package-locks](/configuring-npm/package-locks) +* [npm install](/cli-commands/npm-install) +* [package-locks](/configuring-npm/package-locks) diff --git a/docs/content/cli-commands/npm-completion.md b/docs/content/cli-commands/npm-completion.md index aaa376973e7c5..87685966df016 100755 --- a/docs/content/cli-commands/npm-completion.md +++ b/docs/content/cli-commands/npm-completion.md @@ -38,5 +38,5 @@ completions based on the arguments. ### See Also -* [npm-developers](/using-npm/developers) +* [npm developers](/using-npm/developers) * [npm](/cli-commands/npm) diff --git a/docs/content/cli-commands/npm-config.md b/docs/content/cli-commands/npm-config.md index 791cd294cd150..7082603d11a7b 100755 --- a/docs/content/cli-commands/npm-config.md +++ b/docs/content/cli-commands/npm-config.md @@ -78,8 +78,8 @@ global config. ### See Also -* [npm-folders](/configuring-npm/folders) -* [npm-config](/cli-commands/npm-config) +* [npm folders](/configuring-npm/folders) +* [npm config](/cli-commands/npm-config) * [package.json](/configuring-npm/package-json) * [npmrc](/configuring-npm/npmrc) * [npm](/cli-commands/npm) diff --git a/docs/content/cli-commands/npm-dedupe.md b/docs/content/cli-commands/npm-dedupe.md index 0d130ad6faddc..a4abf53dff107 100755 --- a/docs/content/cli-commands/npm-dedupe.md +++ b/docs/content/cli-commands/npm-dedupe.md @@ -62,6 +62,6 @@ result in new modules being installed. ### See Also -* [npm-ls](/cli-commands/npm-ls) -* [npm-update](/cli-commands/npm-update) -* [npm-install](/cli-commands/npm-install) +* [npm ls](/cli-commands/npm-ls) +* [npm update](/cli-commands/npm-update) +* [npm install](/cli-commands/npm-install) diff --git a/docs/content/cli-commands/npm-deprecate.md b/docs/content/cli-commands/npm-deprecate.md index 9e85036c8d4c3..29fcd62cdacd0 100755 --- a/docs/content/cli-commands/npm-deprecate.md +++ b/docs/content/cli-commands/npm-deprecate.md @@ -32,5 +32,5 @@ format an empty string. ### See Also -* [npm-publish](/cli-commands/npm-publish) -* [npm-registry](/using-npm/registry) +* [npm publish](/cli-commands/npm-publish) +* [npm registry](/using-npm/registry) diff --git a/docs/content/cli-commands/npm-dist-tag.md b/docs/content/cli-commands/npm-dist-tag.md index 2c3a8dc02c552..501975dc50e99 100755 --- a/docs/content/cli-commands/npm-dist-tag.md +++ b/docs/content/cli-commands/npm-dist-tag.md @@ -1,4 +1,4 @@ ---- + --- section: cli-commands title: npm-dist-tag description: Modify package distribution tags @@ -92,9 +92,9 @@ begin with a number or the letter `v`. ### See Also -* [npm-publish](/cli-commands/npm-publish) -* [npm-install](/cli-commands/npm-install) -* [npm-dedupe](/cli-commands/npm-dedupe) -* [npm-registry](/using-npm/registry) -* [npm-config](/cli-commands/npm-config) +* [npm publish](/cli-commands/npm-publish) +* [npm install](/cli-commands/npm-install) +* [npm dedupe](/cli-commands/npm-dedupe) +* [npm registry](/using-npm/registry) +* [npm config](/cli-commands/npm-config) * [npmrc](/configuring-npm/npmrc) diff --git a/docs/content/cli-commands/npm-docs.md b/docs/content/cli-commands/npm-docs.md index 06467af17d098..b53cc5740e60f 100755 --- a/docs/content/cli-commands/npm-docs.md +++ b/docs/content/cli-commands/npm-docs.md @@ -45,9 +45,9 @@ The base URL of the npm package registry. ### See Also -* [npm-view](/cli-commands/npm-view) -* [npm-publish](/cli-commands/npm-publish) -* [npm-registry](/using-npm/registry) -* [npm-config](/cli-commands/npm-config) +* [npm view](/cli-commands/npm-view) +* [npm publish](/cli-commands/npm-publish) +* [npm registry](/using-npm/registry) +* [npm config](/cli-commands/npm-config) * [npmrc](/configuring-npm/npmrc) * [package.json](/configuring-npm/package-json) diff --git a/docs/content/cli-commands/npm-doctor.md b/docs/content/cli-commands/npm-doctor.md index a722fbdaeb780..12f7e2b66e753 100755 --- a/docs/content/cli-commands/npm-doctor.md +++ b/docs/content/cli-commands/npm-doctor.md @@ -106,6 +106,6 @@ cache, you should probably run `npm cache clean` and reset the cache. ### See Also -* [npm-bugs](/cli-commands/npm-bugs) -* [npm-help](/cli-commands/npm-help) -* [npm-ping](/cli-commands/npm-ping) +* [npm bugs](/cli-commands/npm-bugs) +* [npm help](/cli-commands/npm-help) +* [npm ping](/cli-commands/npm-ping) diff --git a/docs/content/cli-commands/npm-edit.md b/docs/content/cli-commands/npm-edit.md index 7fea3db911121..fe62e34cbe8fc 100755 --- a/docs/content/cli-commands/npm-edit.md +++ b/docs/content/cli-commands/npm-edit.md @@ -40,8 +40,8 @@ The command to run for `npm edit` or `npm config edit`. ### See Also -* [npm-folders](/configuring-npm/folders) -* [npm-explore](/cli-commands/npm-explore) -* [npm-install](/cli-commands/npm-install) -* [npm-config](/cli-commands/npm-config) +* [npm folders](/configuring-npm/folders) +* [npm explore](/cli-commands/npm-explore) +* [npm install](/cli-commands/npm-install) +* [npm config](/cli-commands/npm-config) * [npmrc](/configuring-npm/npmrc) diff --git a/docs/content/cli-commands/npm-explore.md b/docs/content/cli-commands/npm-explore.md index d78d4143fe997..e690e57544e8a 100755 --- a/docs/content/cli-commands/npm-explore.md +++ b/docs/content/cli-commands/npm-explore.md @@ -1,4 +1,4 @@ ---- + --- section: cli-commands title: npm-explore description: Browse an installed package @@ -43,8 +43,8 @@ The shell to run for the `npm explore` command. ### See Also -* [npm-folders](/configuring-npm/folders) -* [npm-edit](/cli-commands/npm-edit) -* [npm-rebuild](/cli-commands/npm-rebuild) -* [npm-build](/cli-commands/npm-build) -* [npm-install](/cli-commands/npm-install) +* [npm folders](/configuring-npm/folders) +* [npm edit](/cli-commands/npm-edit) +* [npm rebuild](/cli-commands/npm-rebuild) +* [npm build](/cli-commands/npm-build) +* [npm install](/cli-commands/npm-install) diff --git a/docs/content/cli-commands/npm-help-search.md b/docs/content/cli-commands/npm-help-search.md index 79e954204bd09..be5ba1410e735 100755 --- a/docs/content/cli-commands/npm-help-search.md +++ b/docs/content/cli-commands/npm-help-search.md @@ -40,4 +40,4 @@ If false, then help-search will just list out the help topics found. ### See Also * [npm](/cli-commands/npm) -* [npm-help](/cli-commands/npm-help) +* [npm help](/cli-commands/npm-help) diff --git a/docs/content/cli-commands/npm-help.md b/docs/content/cli-commands/npm-help.md index 7f68d4718b732..724382aae8c4a 100755 --- a/docs/content/cli-commands/npm-help.md +++ b/docs/content/cli-commands/npm-help.md @@ -37,9 +37,9 @@ Set to `"browser"` to view html help content in the default web browser. ### See Also * [npm](/cli-commands/npm) -* [npm-folders](/configuring-npm/folders) -* [npm-config](/cli-commands/npm-config) +* [npm folders](/configuring-npm/folders) +* [npm config](/cli-commands/npm-config) * [npmrc](/configuring-npm/npmrc) * [package.json](/configuring-npm/package-json) -* [npm-help-search](/cli-commands/npm-help-search) -* [npm-index](/cli-commands/npm-index) +* [npm help-search](/cli-commands/npm-help-search) +* [npm index](/cli-commands/npm-index) diff --git a/docs/content/cli-commands/npm-init.md b/docs/content/cli-commands/npm-init.md index 361f90915b3bc..10938aa7011fd 100755 --- a/docs/content/cli-commands/npm-init.md +++ b/docs/content/cli-commands/npm-init.md @@ -70,5 +70,5 @@ will create a scoped package. * * [package.json](/configuring-npm/package-json) -* [npm-version](/cli-commands/npm-version) -* [npm-scope](/using-npm/scope) +* [npm version](/cli-commands/npm-version) +* [npm scope](/using-npm/scope) diff --git a/docs/content/cli-commands/npm-install-ci-test.md b/docs/content/cli-commands/npm-install-ci-test.md index 8978f8fa0076a..46cab812cbe98 100755 --- a/docs/content/cli-commands/npm-install-ci-test.md +++ b/docs/content/cli-commands/npm-install-ci-test.md @@ -22,5 +22,5 @@ This command runs an `npm ci` followed immediately by an `npm test`. ### See Also -* [npm-ci](/cli-commands/npm-ci) -* [npm-test](/cli-commands/npm-test) +* [npm ci](/cli-commands/npm-ci) +* [npm test](/cli-commands/npm-test) diff --git a/docs/content/cli-commands/npm-install-test.md b/docs/content/cli-commands/npm-install-test.md index 3228a94de7bf9..69912084c1be3 100755 --- a/docs/content/cli-commands/npm-install-test.md +++ b/docs/content/cli-commands/npm-install-test.md @@ -31,5 +31,5 @@ takes exactly the same arguments as `npm install`. ### See Also -* [npm-install](/cli-commands/npm-install) -* [npm-test](/cli-commands/npm-test) +* [npm install](/cli-commands/npm-install) +* [npm test](/cli-commands/npm-test) diff --git a/docs/content/cli-commands/npm-install.md b/docs/content/cli-commands/npm-install.md index 5e8cab736015f..684ab9ffa1b7f 100755 --- a/docs/content/cli-commands/npm-install.md +++ b/docs/content/cli-commands/npm-install.md @@ -478,17 +478,17 @@ affects a real use-case, it will be investigated. ### See Also -* [npm-folders](/configuring-npm/folders) -* [npm-update](/cli-commands/npm-update) -* [npm-audit](/cli-commands/npm-audit) -* [npm-link](/cli-commands/npm-link) -* [npm-rebuild](/cli-commands/npm-rebuild) -* [npm-scripts](/using-npm/scripts) -* [npm-build](/cli-commands/npm-build) -* [npm-config](/cli-commands/npm-config) +* [npm folders](/configuring-npm/folders) +* [npm update](/cli-commands/npm-update) +* [npm audit](/cli-commands/npm-audit) +* [npm link](/cli-commands/npm-link) +* [npm rebuild](/cli-commands/npm-rebuild) +* [npm scripts](/using-npm/scripts) +* [npm build](/cli-commands/npm-build) +* [npm config](/cli-commands/npm-config) * [npmrc](/configuring-npm/npmrc) -* [npm-registry](/using-npm/registry) -* [npm-dist-tag](/cli-commands/npm-dist-tag) -* [npm-uninstall](/cli-commands/npm-uninstall) -* [npm-shrinkwrap](/cli-commands/npm-shrinkwrap) +* [npm registry](/using-npm/registry) +* [npm dist-tag](/cli-commands/npm-dist-tag) +* [npm uninstall](/cli-commands/npm-uninstall) +* [npm shrinkwrap](/cli-commands/npm-shrinkwrap) * [package.json](/configuring-npm/package-json) diff --git a/docs/content/cli-commands/npm-link.md b/docs/content/cli-commands/npm-link.md index 4b85503309e2f..c93b9177cccde 100755 --- a/docs/content/cli-commands/npm-link.md +++ b/docs/content/cli-commands/npm-link.md @@ -85,9 +85,9 @@ npm link @myorg/privatepackage ### See Also -* [npm-developers](/using-npm/developers) +* [npm developers](/using-npm/developers) * [package.json](/configuring-npm/package-json) -* [npm-install](/cli-commands/npm-install) -* [npm-folders](/configuring-npm/folders) -* [npm-config](/cli-commands/npm-config) +* [npm- nstall](/cli-commands/npm-install) +* [npm folders](/configuring-npm/folders) +* [npm config](/cli-commands/npm-config) * [npmrc](/configuring-npm/npmrc) diff --git a/docs/content/cli-commands/npm-logout.md b/docs/content/cli-commands/npm-logout.md index 517e38c3cbb74..7a5cf047034bf 100755 --- a/docs/content/cli-commands/npm-logout.md +++ b/docs/content/cli-commands/npm-logout.md @@ -48,7 +48,7 @@ npm logout --scope=@myco ### See Also -* [npm-adduser](/cli-commands/npm-adduser) -* [npm-registry](/using-npm/registry) -* [npm-config](/cli-commands/npm-config) -* [npm-whoami](/cli-commands/npm-whoami) +* [npm adduser](/cli-commands/npm-adduser) +* [npm registry](/using-npm/registry) +* [npm config](/cli-commands/npm-config) +* [npm whoami](/cli-commands/npm-whoami) diff --git a/docs/content/cli-commands/npm-ls.md b/docs/content/cli-commands/npm-ls.md index f84210aa7ef41..1eaa1bb92c4b3 100755 --- a/docs/content/cli-commands/npm-ls.md +++ b/docs/content/cli-commands/npm-ls.md @@ -111,11 +111,11 @@ Display only dependencies which are linked ### See Also -* [npm-config](/cli-commands/npm-config) +* [npm config](/cli-commands/npm-config) * [npmrc](/configuring-npm/npmrc) -* [npm-folders](/configuring-npm/folders) -* [npm-install](/cli-commands/npm-install) -* [npm-link](/cli-commands/npm-link) -* [npm-prune](/cli-commands/npm-prune) -* [npm-outdated](/cli-commands/npm-outdated) -* [npm-update](/cli-commands/npm-update) +* [npm folders](/configuring-npm/folders) +* [npm install](/cli-commands/npm-install) +* [npm link](/cli-commands/npm-link) +* [npm prune](/cli-commands/npm-prune) +* [npm outdated](/cli-commands/npm-outdated) +* [npm update](/cli-commands/npm-update) diff --git a/docs/content/cli-commands/npm-outdated.md b/docs/content/cli-commands/npm-outdated.md index 92c7bd094de2f..44ec0b3cf2485 100755 --- a/docs/content/cli-commands/npm-outdated.md +++ b/docs/content/cli-commands/npm-outdated.md @@ -118,7 +118,7 @@ Max depth for checking dependency tree. ### See Also -* [npm-update](/cli-commands/npm-update) -* [npm-dist-tag](/cli-commands/npm-dist-tag) -* [npm-registry](/using-npm/registry) -* [npm-folders](/configuring-npm/folders) +* [npm update](/cli-commands/npm-update) +* [npm dist-tag](/cli-commands/npm-dist-tag) +* [npm registry](/using-npm/registry) +* [npm folders](/configuring-npm/folders) diff --git a/docs/content/cli-commands/npm-owner.md b/docs/content/cli-commands/npm-owner.md index 6bf8fee8bb40e..7c803b915dd47 100755 --- a/docs/content/cli-commands/npm-owner.md +++ b/docs/content/cli-commands/npm-owner.md @@ -41,7 +41,7 @@ with `--otp`. ### See Also -* [npm-publish](/cli-commands/npm-publish) -* [npm-registry](/using-npm/registry) -* [npm-adduser](/cli-commands/npm-adduser) -* [npm-disputes](/using-npm/disputes) +* [npm publish](/cli-commands/npm-publish) +* [npm registry](/using-npm/registry) +* [npm adduser](/cli-commands/npm-adduser) +* [npm disputes](/using-npm/disputes) diff --git a/docs/content/cli-commands/npm-pack.md b/docs/content/cli-commands/npm-pack.md index 8fdd1ba98caae..70caa02d2b439 100755 --- a/docs/content/cli-commands/npm-pack.md +++ b/docs/content/cli-commands/npm-pack.md @@ -32,7 +32,7 @@ actually packing anything. Reports on what would have gone into the tarball. ### See Also -* [npm-cache](/cli-commands/npm-cache) -* [npm-publish](/cli-commands/npm-publish) -* [npm-config](/cli-commands/npm-config) +* [npm cache](/cli-commands/npm-cache) +* [npm publish](/cli-commands/npm-publish) +* [npm config](/cli-commands/npm-config) * [npmrc](/configuring-npm/npmrc) diff --git a/docs/content/cli-commands/npm-ping.md b/docs/content/cli-commands/npm-ping.md index 8c0d59d4daa89..468734bd1f0d2 100755 --- a/docs/content/cli-commands/npm-ping.md +++ b/docs/content/cli-commands/npm-ping.md @@ -29,5 +29,5 @@ Ping error: {*Detail about error} ### See Also -* [npm-config](/cli-commands/npm-config) +* [npm config](/cli-commands/npm-config) * [npmrc](/configuring-npm/npmrc) diff --git a/docs/content/cli-commands/npm-prefix.md b/docs/content/cli-commands/npm-prefix.md index 507f3e021d1b6..f2fd3e4f19d4f 100755 --- a/docs/content/cli-commands/npm-prefix.md +++ b/docs/content/cli-commands/npm-prefix.md @@ -25,8 +25,8 @@ If `-g` is specified, this will be the value of the global prefix. See ### See Also -* [npm-root](/cli-commands/npm-root) -* [npm-bin](/cli-commands/npm-bin) -* [npm-folders](/configuring-npm/folders) -* [npm-config](/cli-commands/npm-config) +* [npm root](/cli-commands/npm-root) +* [npm bin](/cli-commands/npm-bin) +* [npm folders](/configuring-npm/folders) +* [npm config](/cli-commands/npm-config) * [npmrc](/configuring-npm/npmrc) diff --git a/docs/content/cli-commands/npm-profile.md b/docs/content/cli-commands/npm-profile.md index 6687db82b0370..1f3b146b8ad4c 100755 --- a/docs/content/cli-commands/npm-profile.md +++ b/docs/content/cli-commands/npm-profile.md @@ -79,4 +79,4 @@ available on non npmjs.com registries. ### See Also -* [npm-config](/cli-commands/npm-config) +* [npm config](/cli-commands/npm-config) diff --git a/docs/content/cli-commands/npm-prune.md b/docs/content/cli-commands/npm-prune.md index c97c40deab1f0..93c7efe8d4394 100755 --- a/docs/content/cli-commands/npm-prune.md +++ b/docs/content/cli-commands/npm-prune.md @@ -41,6 +41,6 @@ and it's up to you to run `npm prune` from time-to-time to remove them. ### See Also -* [npm-uninstall](/cli-commands/npm-uninstall) -* [npm-folders](/configuring-npm/folders) -* [npm-ls](/cli-commands/npm-ls) +* [npm uninstall](/cli-commands/npm-uninstall) +* [npm folders](/configuring-npm/folders) +* [npm ls](/cli-commands/npm-ls) diff --git a/docs/content/cli-commands/npm-publish.md b/docs/content/cli-commands/npm-publish.md index c7bc202f945f4..698aad87a2449 100755 --- a/docs/content/cli-commands/npm-publish.md +++ b/docs/content/cli-commands/npm-publish.md @@ -73,11 +73,11 @@ included and packs them into a tarball to be uploaded to the registry. ### See Also -* [npm-registry](/using-npm/registry) -* [npm-scope](/using-npm/scope) -* [npm-adduser](/cli-commands/npm-adduser) -* [npm-owner](/cli-commands/npm-owner) -* [npm-deprecate](/cli-commands/npm-deprecate) -* [npm-dist-tag](/cli-commands/npm-dist-tag) -* [npm-pack](/cli-commands/npm-pack) -* [npm-profile](/cli-commands/npm-profile) +* [npm registry](/using-npm/registry) +* [npm scope](/using-npm/scope) +* [npm adduser](/cli-commands/npm-adduser) +* [npm owner](/cli-commands/npm-owner) +* [npm deprecate](/cli-commands/npm-deprecate) +* [npm dist-tag](/cli-commands/npm-dist-tag) +* [npm pack](/cli-commands/npm-pack) +* [npm profile](/cli-commands/npm-profile) diff --git a/docs/content/cli-commands/npm-rebuild.md b/docs/content/cli-commands/npm-rebuild.md index ac133d7285cef..8ec9c0302de65 100755 --- a/docs/content/cli-commands/npm-rebuild.md +++ b/docs/content/cli-commands/npm-rebuild.md @@ -24,5 +24,5 @@ the new binary. ### See Also -* [npm-build](/cli-commands/npm-build) -* [npm-install](/cli-commands/npm-install) +* [npm build](/cli-commands/npm-build) +* [npm install](/cli-commands/npm-install) diff --git a/docs/content/cli-commands/npm-repo.md b/docs/content/cli-commands/npm-repo.md index 1e8e54b6b3d02..bcebecb69064c 100755 --- a/docs/content/cli-commands/npm-repo.md +++ b/docs/content/cli-commands/npm-repo.md @@ -32,5 +32,5 @@ The browser that is called by the `npm repo` command to open websites. ### See Also -* [npm-docs](/cli-commands/npm-docs) -* [npm-config](/cli-commands/npm-config) +* [npm docs](/cli-commands/npm-docs) +* [npm config](/cli-commands/npm-config) diff --git a/docs/content/cli-commands/npm-restart.md b/docs/content/cli-commands/npm-restart.md index f05e46d58d37e..ba4e589b7ac51 100755 --- a/docs/content/cli-commands/npm-restart.md +++ b/docs/content/cli-commands/npm-restart.md @@ -41,9 +41,9 @@ behavior will be accompanied by an increase in major version number ### See Also -* [npm-run-script](/cli-commands/npm-run-script) -* [npm-scripts](/cli-commands//docs/using-npm/scripts) -* [npm-test](/cli-commands/npm-test) -* [npm-start](/cli-commands/npm-start) -* [npm-stop](/cli-commands/npm-stop) -* [npm-restart](/cli-commands/npm-restart) \ No newline at end of file +* [npm run-script](/cli-commands/npm-run-script) +* [npm scripts](/cli-commands//docs/using-npm/scripts) +* [npm test](/cli-commands/npm-test) +* [npm start](/cli-commands/npm-start) +* [npm stop](/cli-commands/npm-stop) +* [npm restart](/cli-commands/npm-restart) \ No newline at end of file diff --git a/docs/content/cli-commands/npm-root.md b/docs/content/cli-commands/npm-root.md index acca16a53f403..d654f1c58b42b 100755 --- a/docs/content/cli-commands/npm-root.md +++ b/docs/content/cli-commands/npm-root.md @@ -19,8 +19,8 @@ Print the effective `node_modules` folder to standard out. ### See Also -* [npm-prefix](/cli-commands/npm-prefix) -* [npm-bin](/cli-commands/npm-bin) -* [npm-folders](/configuring-npm/folders) -* [npm-config](/cli-commands/npm-config) +* [npm prefix](/cli-commands/npm-prefix) +* [npm bin](/cli-commands/npm-bin) +* [npm folders](/configuring-npm/folders) +* [npm config](/cli-commands/npm-config) * [npmrc](/configuring-npm/npmrc) diff --git a/docs/content/cli-commands/npm-run-script.md b/docs/content/cli-commands/npm-run-script.md index c4b96f5e8b9f5..9d71616ab8ee1 100755 --- a/docs/content/cli-commands/npm-run-script.md +++ b/docs/content/cli-commands/npm-run-script.md @@ -89,9 +89,9 @@ without breaking the execution chain. ### See Also -* [npm-scripts](/using-npm/scripts) -* [npm-test](/cli-commands/npm-test) -* [npm-start](/cli-commands/npm-start) -* [npm-restart](/cli-commands/npm-restart) -* [npm-stop](/cli-commands/npm-stop) -* [npm-config](/cli-commands/npm-config) +* [npm scripts](/using-npm/scripts) +* [npm test](/cli-commands/npm-test) +* [npm start](/cli-commands/npm-start) +* [npm restart](/cli-commands/npm-restart) +* [npm stop](/cli-commands/npm-stop) +* [npm config](/cli-commands/npm-config) diff --git a/docs/content/cli-commands/npm-search.md b/docs/content/cli-commands/npm-search.md index c958c1df802b2..76735e941bd72 100755 --- a/docs/content/cli-commands/npm-search.md +++ b/docs/content/cli-commands/npm-search.md @@ -108,7 +108,7 @@ setting. ### See Also -* [npm-registry](/using-npm/registry) -* [npm-config](/cli-commands/npm-config) +* [npm registry](/using-npm/registry) +* [npm config](/cli-commands/npm-config) * [npmrc](/configuring-npm/npmrc) -* [npm-view](/cli-commands/npm-view) +* [npm view](/cli-commands/npm-view) diff --git a/docs/content/cli-commands/npm-shrinkwrap.md b/docs/content/cli-commands/npm-shrinkwrap.md index a5913e9e40bc4..147ffe393749e 100755 --- a/docs/content/cli-commands/npm-shrinkwrap.md +++ b/docs/content/cli-commands/npm-shrinkwrap.md @@ -24,11 +24,11 @@ of package locks in npm, see [npm-package-locks](npm-package-locks). ### See Also -* [npm-install](/cli-commands/npm-install) -* [npm-run-script](/cli-commands/npm-run-script) -* [npm-scripts](/using-npm/scripts) +* [npm install](/cli-commands/npm-install) +* [npm run-script](/cli-commands/npm-run-script) +* [npm scripts](/using-npm/scripts) * [package.js](/configuring-npm/package-json) -* [npm-package-locks](/configuring-npm/package-locks) +* [package-locks](/configuring-npm/package-locks) * [package-lock.json](/configuring-npm/package-lock-json) -* [npm-shrinkwrap.json](/configuring-npm/shrinkwrap-json) -* [npm-ls](/cli-commands/npm-ls) +* [shrinkwrap.json](/configuring-npm/shrinkwrap-json) +* [npm ls](/cli-commands/npm-ls) diff --git a/docs/content/cli-commands/npm-star.md b/docs/content/cli-commands/npm-star.md index 58fb373c606e9..77841e03038f1 100755 --- a/docs/content/cli-commands/npm-star.md +++ b/docs/content/cli-commands/npm-star.md @@ -26,6 +26,6 @@ It's a boolean thing. Starring repeatedly has no additional effect. ### See Also -* [npm-view](/cli-commands/npm-view) -* [npm-whoami](/cli-commands/npm-whoami) -* [npm-adduser](/cli-commands/npm-adduser) +* [npm view](/cli-commands/npm-view) +* [npm whoami](/cli-commands/npm-whoami) +* [npm adduser](/cli-commands/npm-adduser) diff --git a/docs/content/cli-commands/npm-stars.md b/docs/content/cli-commands/npm-stars.md index cf4a06eefffca..7dbb9ece8acd5 100755 --- a/docs/content/cli-commands/npm-stars.md +++ b/docs/content/cli-commands/npm-stars.md @@ -23,7 +23,7 @@ you will most certainly enjoy this command. ### See Also -* [npm-star](/cli-commands/npm-star) -* [npm-view](/cli-commands/npm-view) -* [npm-whoami](/cli-commands/npm-whoami) -* [npm-adduser](/cli-commands/npm-adduser) +* [npm star](/cli-commands/npm-star) +* [npm view](/cli-commands/npm-view) +* [npm whoami](/cli-commands/npm-whoami) +* [npm adduser](/cli-commands/npm-adduser) diff --git a/docs/content/cli-commands/npm-start.md b/docs/content/cli-commands/npm-start.md index bec263c34bf0b..fdbae4b103e09 100755 --- a/docs/content/cli-commands/npm-start.md +++ b/docs/content/cli-commands/npm-start.md @@ -26,8 +26,8 @@ more details. ### See Also -* [npm-run-script](/cli-commands/npm-run-script) -* [npm-scripts](/using-npm/scripts) -* [npm-test](/cli-commands/npm-test) -* [npm-restart](/cli-commands/npm-restart) -* [npm-stop](/cli-commands/npm-stop) +* [npm run-script](/cli-commands/npm-run-script) +* [npm scripts](/using-npm/scripts) +* [npm test](/cli-commands/npm-test) +* [npm restart](/cli-commands/npm-restart) +* [npm stop](/cli-commands/npm-stop) diff --git a/docs/content/cli-commands/npm-stop.md b/docs/content/cli-commands/npm-stop.md index 0697ba6712f91..62d6478f2e68c 100755 --- a/docs/content/cli-commands/npm-stop.md +++ b/docs/content/cli-commands/npm-stop.md @@ -20,8 +20,8 @@ This runs a package's "stop" script, if one was provided. ### See Also -* [npm-run-script](/cli-commands/npm-run-script) -* [npm-scripts](/using-npm/scripts) -* [npm-test](/cli-commands/npm-test) -* [npm-start](/cli-commands/npm-start) -* [npm-restart](/cli-commands/npm-restart) +* [npm run-script](/cli-commands/npm-run-script) +* [npm scripts](/using-npm/scripts) +* [npm test](/cli-commands/npm-test) +* [npm start](/cli-commands/npm-start) +* [npm restart](/cli-commands/npm-restart) diff --git a/docs/content/cli-commands/npm-team.md b/docs/content/cli-commands/npm-team.md index 70e196f0d7ba0..3401dae26b369 100755 --- a/docs/content/cli-commands/npm-team.md +++ b/docs/content/cli-commands/npm-team.md @@ -63,5 +63,5 @@ use the `npm access` command to grant or revoke the appropriate permissions. ### See Also -* [npm-access](/cli-commands/npm-access) -* [npm-registry](/using-npm/registry) +* [npm access](/cli-commands/npm-access) +* [npm registry](/using-npm/registry) diff --git a/docs/content/cli-commands/npm-test.md b/docs/content/cli-commands/npm-test.md index f334c930c83cd..af393ae99e333 100755 --- a/docs/content/cli-commands/npm-test.md +++ b/docs/content/cli-commands/npm-test.md @@ -22,8 +22,8 @@ This runs a package's "test" script, if one was provided. ### See Also -* [npm-run-script](/cli-commands/npm-run-script) -* [npm-scripts](/using-npm/scripts) -* [npm-start](/cli-commands/npm-start) -* [npm-restart](/cli-commands/npm-restart) -* [npm-stop](/cli-commands/npm-stop) +* [npm run-script](/cli-commands/npm-run-script) +* [npm scripts](/using-npm/scripts) +* [npm start](/cli-commands/npm-start) +* [npm restart](/cli-commands/npm-restart) +* [npm stop](/cli-commands/npm-stop) diff --git a/docs/content/cli-commands/npm-uninstall.md b/docs/content/cli-commands/npm-uninstall.md index 735514ad35db5..932e1015c92d7 100755 --- a/docs/content/cli-commands/npm-uninstall.md +++ b/docs/content/cli-commands/npm-uninstall.md @@ -57,8 +57,8 @@ npm uninstall lodash --no-save ### See Also -* [npm-prune](/cli-commands/npm-prune) -* [npm-install](/cli-commands/npm-install) -* [npm-folders](/configuring-npm/folders) -* [npm-config](/cli-commands/npm-config) +* [npm prune](/cli-commands/npm-prune) +* [npm install](/cli-commands/npm-install) +* [npm folders](/configuring-npm/folders) +* [npm config](/cli-commands/npm-config) * [npmrc](/configuring-npm/npmrc) diff --git a/docs/content/cli-commands/npm-unpublish.md b/docs/content/cli-commands/npm-unpublish.md index 6bc67a30466a2..de37f382912ea 100755 --- a/docs/content/cli-commands/npm-unpublish.md +++ b/docs/content/cli-commands/npm-unpublish.md @@ -47,8 +47,8 @@ The scope is optional and follows the usual rules for [`npm-scope`](/docs/using- ### See Also -* [npm-deprecate](/cli-commands/npm-deprecate) -* [npm-publish](/cli-commands/npm-publish) -* [npm-registry](/using-npm/registry) -* [npm-adduser](/cli-commands/npm-adduser) -* [npm-owner](/cli-commands/npm-owner) +* [npm deprecate](/cli-commands/npm-deprecate) +* [npm publish](/cli-commands/npm-publish) +* [npm registry](/using-npm/registry) +* [npm adduser](/cli-commands/npm-adduser) +* [npm owner](/cli-commands/npm-owner) diff --git a/docs/content/cli-commands/npm-update.md b/docs/content/cli-commands/npm-update.md index ff2463ce8faaf..2eb0235faee81 100755 --- a/docs/content/cli-commands/npm-update.md +++ b/docs/content/cli-commands/npm-update.md @@ -130,9 +130,9 @@ be _downgraded_. ### See Also -* [npm-install](/cli-commands/npm-install) -* [npm-outdated](/cli-commands/npm-outdated) -* [npm-shrinkwrap](/cli-commands/npm-shrinkwrap) -* [npm-registry](/using-npm/registry) -* [npm-folders](/configuring-npm/folders) -* [npm-ls](/cli-commands/npm-ls) +* [npm install](/cli-commands/npm-install) +* [npm outdated](/cli-commands/npm-outdated) +* [npm shrinkwrap](/cli-commands/npm-shrinkwrap) +* [npm registry](/using-npm/registry) +* [npm folders](/configuring-npm/folders) +* [npm ls](/cli-commands/npm-ls) diff --git a/docs/content/cli-commands/npm-version.md b/docs/content/cli-commands/npm-version.md index 1fefb7e79a832..f9e34feb995b3 100755 --- a/docs/content/cli-commands/npm-version.md +++ b/docs/content/cli-commands/npm-version.md @@ -126,9 +126,9 @@ Note that you must have a default GPG key set up in your git config for this to ### See Also -* [npm-init](/cli-commands/npm-init) -* [npm-run-script](/cli-commands/npm-run-script) -* [npm-scripts](/using-npm/scripts) +* [npm init](/cli-commands/npm-init) +* [npm run-script](/cli-commands/npm-run-script) +* [npm scripts](/using-npm/scripts) * [package.json](/docs/configuring-npm/package-json) * [semver](/using-npm/semver) * [config](/using-npm/config) diff --git a/docs/content/cli-commands/npm-view.md b/docs/content/cli-commands/npm-view.md index 266e8d0cb2dbe..bbea3f860c0ab 100755 --- a/docs/content/cli-commands/npm-view.md +++ b/docs/content/cli-commands/npm-view.md @@ -117,8 +117,8 @@ the field name. ### See Also -* [npm-search](/cli-commands/npm-search) -* [npm-registry](/using-npm/registry) -* [npm-config](/cli-commands/npm-config) +* [npm search](/cli-commands/npm-search) +* [npm registry](/using-npm/registry) +* [npm config](/cli-commands/npm-config) * [npmrc](/configuring-npm/npmrc) -* [npm-docs](/cli-commands/npm-docs) +* [npm docs](/cli-commands/npm-docs) diff --git a/docs/content/cli-commands/npm-whoami.md b/docs/content/cli-commands/npm-whoami.md index 0e14e67e5b9f5..2fa9441626cd5 100755 --- a/docs/content/cli-commands/npm-whoami.md +++ b/docs/content/cli-commands/npm-whoami.md @@ -19,6 +19,6 @@ Print the `username` config to standard output. ### See Also -* [npm-config](/cli-commands/npm-config) +* [npm config](/cli-commands/npm-config) * [npmrc](/configuring-npm/npmrc) -* [npm-adduser](/cli-commands/npm-adduser) +* [npm adduser](/cli-commands/npm-adduser) diff --git a/docs/content/cli-commands/npm.md b/docs/content/cli-commands/npm.md index 6e5ac3080b68a..55797dbdf6295 100755 --- a/docs/content/cli-commands/npm.md +++ b/docs/content/cli-commands/npm.md @@ -162,8 +162,8 @@ reproduction to report. ### See Also -* [npm-help](/cli-commands/npm-help) +* [npm help](/cli-commands/npm-help) * [package.json](/configuring-npm/package-json) -* [npm-install](/cli-commands/npm-install) -* [npm-config](/cli-commands/npm-config) +* [npm install](/cli-commands/npm-install) +* [npm config](/cli-commands/npm-config) * [npmrc](/configuring-npm/npmrc) diff --git a/docs/content/configuring-npm/folders.md b/docs/content/configuring-npm/folders.md index 8a55f68a4b6bf..913f90cbf81ff 100755 --- a/docs/content/configuring-npm/folders.md +++ b/docs/content/configuring-npm/folders.md @@ -215,10 +215,10 @@ cannot be found elsewhere. See [`package.json`](/docs/configuring-npm/package.j ### See also * [package.json](/configuring-npm/package-json) -* [npm-install](/cli-commands/npm-install) -* [npm-pack](/cli-commands/npm-pack) -* [npm-cache](/cli-commands/npm-cache) -* [npm-config](/cli-commands/npm-config) +* [npm install](/cli-commands/npm-install) +* [npm pack](/cli-commands/npm-pack) +* [npm cache](/cli-commands/npm-cache) +* [npm config](/cli-commands/npm-config) * [npmrc](/configuring-npm/npmrc) * [config](/using-npm/config) -* [npm-publish](/cli-commands/npm-publish) +* [npm publish](/cli-commands/npm-publish) diff --git a/docs/content/configuring-npm/install.md b/docs/content/configuring-npm/install.md index f800ff228e65f..4de8492dee948 100644 --- a/docs/content/configuring-npm/install.md +++ b/docs/content/configuring-npm/install.md @@ -1,6 +1,6 @@ --- section: configuring-npm -title: 00 install +title: install description: Download and install node and npm --- diff --git a/docs/content/configuring-npm/npmrc.md b/docs/content/configuring-npm/npmrc.md index d4f3911534184..b1a66ce10bf97 100755 --- a/docs/content/configuring-npm/npmrc.md +++ b/docs/content/configuring-npm/npmrc.md @@ -96,8 +96,8 @@ manner. ### See also -* [npm-folders](/configuring-npm/folders) -* [npm-config](/cli-commands/npm-config) +* [npm folders](/configuring-npm/folders) +* [npm config](/cli-commands/npm-config) * [config](/using-npm/config) * [package.json](/configuring-npm/package-json) * [npm](/cli-commands/npm) diff --git a/docs/content/configuring-npm/package-json.md b/docs/content/configuring-npm/package-json.md index 143fe4a9d5838..92700887136e5 100755 --- a/docs/content/configuring-npm/package-json.md +++ b/docs/content/configuring-npm/package-json.md @@ -872,10 +872,10 @@ npm will default some values based on package contents. ### SEE ALSO * [semver](/using-npm/semver) -* [npm-init](/cli-commands/npm-init) -* [npm-version](/cli-commands/npm-version) -* [npm-config](/cli-commands/npm-config) -* [npm-help](/cli-commands/npm-help) -* [npm-install](/cli-commands/npm-install) -* [npm-publish](/cli-commands/npm-publish) -* [npm-uninstall](/cli-commands/npm-uninstall) +* [npm init](/cli-commands/npm-init) +* [npm version](/cli-commands/npm-version) +* [npm config](/cli-commands/npm-config) +* [npm help](/cli-commands/npm-help) +* [npm install](/cli-commands/npm-install) +* [npm publish](/cli-commands/npm-publish) +* [npm uninstall](/cli-commands/npm-uninstall) diff --git a/docs/content/configuring-npm/package-lock-json.md b/docs/content/configuring-npm/package-lock-json.md index c4d9698b64c79..33a74f55fed88 100755 --- a/docs/content/configuring-npm/package-lock-json.md +++ b/docs/content/configuring-npm/package-lock-json.md @@ -142,8 +142,8 @@ The dependencies of this dependency, exactly as at the top level. ### See also -* [npm-shrinkwrap](/cli-commands/npm-shrinkwrap) -* [npm-shrinkwrap.json](/configuring-npm/shrinkwrap-json) -* [npm-package-locks](/configuring-npm/package-locks) +* [npm shrinkwrap](/cli-commands/npm-shrinkwrap) +* [shrinkwrap.json](/configuring-npm/shrinkwrap-json) +* [package-locks](/configuring-npm/package-locks) * [package.json](/configuring-npm/package-json) -* [npm-install](/cli-commands/npm-install) +* [npm install](/cli-commands/npm-install) diff --git a/docs/content/configuring-npm/package-locks.md b/docs/content/configuring-npm/package-locks.md index 3e0a2fc222462..acdf29136f0b4 100755 --- a/docs/content/configuring-npm/package-locks.md +++ b/docs/content/configuring-npm/package-locks.md @@ -179,5 +179,5 @@ pre-`npm@5.7.0` versions of npm 5, albeit a bit more noisily. Note that if * https://medium.com/@sdboyer/so-you-want-to-write-a-package-manager-4ae9c17d9527 * [package.json](/configuring-npm/package-json) * [package-lock.json](/configuring-npm/package-lock-json) -* [npm-shrinkwrap.json](/configuring-npm/shrinkwrap-json) -* [npm-shrinkwrap](/cli-commands/npm-shrinkwrap) +* [shrinkwrap.json](/configuring-npm/shrinkwrap-json) +* [npm shrinkwrap](/cli-commands/npm-shrinkwrap) diff --git a/docs/content/configuring-npm/shrinkwrap-json.md b/docs/content/configuring-npm/shrinkwrap-json.md index e9ed04fc30e9e..f32c1bc970a61 100755 --- a/docs/content/configuring-npm/shrinkwrap-json.md +++ b/docs/content/configuring-npm/shrinkwrap-json.md @@ -28,7 +28,7 @@ to the manual page for [package-lock.json](/docs/configuring-npm/package-lock-js ### See also -* [npm-shrinkwrap](/cli-commands/npm-shrinkwrap) +* [npm shrinkwrap](/cli-commands/npm-shrinkwrap) * [package-lock.json](/configuring-npm/package-lock-json) * [package.json](/configuring-npm/package-json) -* [npm-install](/cli-commands/npm-install) +* [npm install](/cli-commands/npm-install) diff --git a/docs/content/using-npm/coding-style.md b/docs/content/using-npm/coding-style.md index db48149253379..e329bda7d93d8 100755 --- a/docs/content/using-npm/coding-style.md +++ b/docs/content/using-npm/coding-style.md @@ -208,5 +208,5 @@ Boolean objects are forbidden. ### See Also -* [npm-developers](/using-npm/developers) +* [npm developers](/using-npm/developers) * [npm](/cli-commands/npm) diff --git a/docs/content/using-npm/config.md b/docs/content/using-npm/config.md index fd64541ac76f9..4a0fd5f07199a 100755 --- a/docs/content/using-npm/config.md +++ b/docs/content/using-npm/config.md @@ -1284,8 +1284,8 @@ Set to `"browser"` to view html help content in the default web browser. ### See also -* [npm-config](/cli-commands/npm-config) +* [npm config](/cli-commands/npm-config) * [npmrc](/configuring-npm/npmrc) -* [npm-scripts](/using-npm/scripts) -* [npm-folders](/configuring-npm/folders) +* [npm scripts](/using-npm/scripts) +* [npm folders](/configuring-npm/folders) * [npm](/cli-commands/npm) diff --git a/docs/content/using-npm/developers.md b/docs/content/using-npm/developers.md index 9db120ce1bb0c..ed4572d478571 100755 --- a/docs/content/using-npm/developers.md +++ b/docs/content/using-npm/developers.md @@ -244,9 +244,9 @@ Tell the world how easy it is to install your program! ### See also * [npm](/cli-commands/npm) -* [npm-init](/cli-commands/npm-init) +* [npm init](/cli-commands/npm-init) * [package.json](/configuring-npm/package-json) -* [npm-scripts](/using-npm/scripts) -* [npm-publish](/cli-commands/npm-publish) -* [npm-adduser](/cli-commands/npm-adduser) -* [npm-registry](/using-npm/registry) +* [npm scripts](/using-npm/scripts) +* [npm publish](/cli-commands/npm-publish) +* [npm adduser](/cli-commands/npm-adduser) +* [npm registry](/using-npm/registry) diff --git a/docs/content/using-npm/disputes.md b/docs/content/using-npm/disputes.md index 54fe2a1a4f471..69397164d2e46 100755 --- a/docs/content/using-npm/disputes.md +++ b/docs/content/using-npm/disputes.md @@ -133,5 +133,5 @@ License. ### See also -* [npm-registry](/using-npm/registry) -* [npm-owner](/cli-commands/npm-owner) +* [npm registry](/using-npm/registry) +* [npm owner](/cli-commands/npm-owner) diff --git a/docs/content/using-npm/orgs.md b/docs/content/using-npm/orgs.md index cd87f1b2df47f..8f1935dee89cc 100755 --- a/docs/content/using-npm/orgs.md +++ b/docs/content/using-npm/orgs.md @@ -92,6 +92,6 @@ npm access ls-collaborators ### See also -* [npm-team](/cli-commands/npm-team) -* [npm-access](/cli-commands/npm-access) -* [npm-scope](/using-npm/scope) +* [npm team](/cli-commands/npm-team) +* [npm access](/cli-commands/npm-access) +* [npm scope](/using-npm/scope) diff --git a/docs/content/using-npm/registry.md b/docs/content/using-npm/registry.md index 7bde7ec07cc96..8dbcba082bff4 100755 --- a/docs/content/using-npm/registry.md +++ b/docs/content/using-npm/registry.md @@ -100,8 +100,8 @@ Yes, head over to ### See also -* [npm-config](/cli-commands/npm-config) +* [npm config](/cli-commands/npm-config) * [config](/using-npm/config) * [npmrc](/configuring-npm/npmrc) -* [npm-developers](/using-npm/developers) -* [npm-disputes](/using-npm/disputes) +* [npm developers](/using-npm/developers) +* [npm disputes](/using-npm/disputes) diff --git a/docs/content/using-npm/removal.md b/docs/content/using-npm/removal.md index 299bf7a5757e1..522ac2af53f19 100755 --- a/docs/content/using-npm/removal.md +++ b/docs/content/using-npm/removal.md @@ -67,5 +67,5 @@ find /usr/local/{lib/node,bin} -exec grep -l npm \{\} \; ; ### See also * README -* [npm-uninstall](/cli-commands/npm-uninstall) -* [npm-prune](/cli-commands/npm-prune) +* [npm uninstall](/cli-commands/npm-uninstall) +* [npm prune](/cli-commands/npm-prune) diff --git a/docs/content/using-npm/scope.md b/docs/content/using-npm/scope.md index 7aee7492fd680..fe5d897631130 100755 --- a/docs/content/using-npm/scope.md +++ b/docs/content/using-npm/scope.md @@ -125,7 +125,7 @@ that registry instead. ### See also -* [npm-install](/cli-commands/npm-install) -* [npm-publish](/cli-commands/npm-publish) -* [npm-access](/cli-commands/npm-access) -* [npm-registry](/using-npm/registry) +* [npm install](/cli-commands/npm-install) +* [npm publish](/cli-commands/npm-publish) +* [npm access](/cli-commands/npm-access) +* [npm registry](/using-npm/registry) diff --git a/docs/content/using-npm/scripts.md b/docs/content/using-npm/scripts.md index 2f2d9ed2add76..4894d71b5bc59 100755 --- a/docs/content/using-npm/scripts.md +++ b/docs/content/using-npm/scripts.md @@ -283,7 +283,7 @@ above. ### See Also -* [npm-run-script](/cli-commands/npm-run-script) +* [npm run-script](/cli-commands/npm-run-script) * [package.json](/configuring-npm/package-json) -* [npm-developers](/using-npm/developers) -* [npm-install](/cli-commands/npm-install) +* [npm developers](/using-npm/developers) +* [npm install](/cli-commands/npm-install) diff --git a/docs/gatsby-ssr.js b/docs/gatsby-ssr.js deleted file mode 100644 index b17b8fc19d659..0000000000000 --- a/docs/gatsby-ssr.js +++ /dev/null @@ -1,7 +0,0 @@ -/** - * Implement Gatsby's SSR (Server Side Rendering) APIs in this file. - * - * See: https://www.gatsbyjs.org/docs/ssr-apis/ - */ - -// You can delete this file if you're not using it diff --git a/docs/src/.DS_Store b/docs/src/.DS_Store deleted file mode 100644 index 5008ddfcf53c0..0000000000000 Binary files a/docs/src/.DS_Store and /dev/null differ diff --git a/docs/src/components/DocLinks.js b/docs/src/components/DocLinks.js index d2aaf1006a9a0..27c85582e13bf 100644 --- a/docs/src/components/DocLinks.js +++ b/docs/src/components/DocLinks.js @@ -29,20 +29,26 @@ const DocLinks = ({data}) => { return sections.map((section, index) => ( - {sortedData[section].map((linkData, index) => ( - - - {linkData.frontmatter.title} - {linkData.frontmatter.description} - - - ))} + {sortedData[section].map((linkData, index) => { + const title = section === 'cli-commands' + ? linkData.frontmatter.title.replace(/(npm-)+([a-zA-Z\\.-]*)/, 'npm $2') + : linkData.frontmatter.title + + return ( + + + {title} + {linkData.frontmatter.description} + + + ) + }) + } - ) - ) + )) } export default props => ( diff --git a/docs/src/images/gatsby-astronaut.png b/docs/src/images/gatsby-astronaut.png deleted file mode 100644 index da58ece0a8c5b..0000000000000 Binary files a/docs/src/images/gatsby-astronaut.png and /dev/null differ diff --git a/docs/src/images/gatsby-icon.png b/docs/src/images/gatsby-icon.png deleted file mode 100644 index 908bc78a7f559..0000000000000 Binary files a/docs/src/images/gatsby-icon.png and /dev/null differ diff --git a/docs/src/templates/Page.js b/docs/src/templates/Page.js index 5dffdfd51bd78..a79abf1719ef3 100644 --- a/docs/src/templates/Page.js +++ b/docs/src/templates/Page.js @@ -14,12 +14,13 @@ const Content = styled.div` const Page = ({data}) => { const pageData = data.markdownRemark + const html = pageData.html.replace(/(npm-)+([a-zA-Z\\.-]*)<\/h1>/g, 'npm $2') return ( -
+
diff --git a/scripts/docs-build.js b/scripts/docs-build.js index 4f59e5484514e..fd7d74f642a0a 100644 --- a/scripts/docs-build.js +++ b/scripts/docs-build.js @@ -13,20 +13,19 @@ fs.readFile(src, 'utf8', function (err, data) { var fileExt = src.split('.').pop() var result = data.replace(/@VERSION@/g, npm.version) - if (fileExt === 'md') { - result = marked( - result.replace(/\-\-\-([\s\S]+)\-\-\-/g, '') - .replace(/(npm-)?([a-zA-Z\\\.\-]*)\(1\)/g, 'npm help $2') - .replace(/(npm-)?([a-zA-Z\\\.\-]*)\((5|7)\)/g, 'npm help $2') - .replace(/(npm-)?([a-zA-Z\\\.\-]*)\(3\)/g, 'npm apihelp $2') - .replace(/npm(1)/g, 'npm help npm') - .replace(/npm(3)/g, 'npm apihelp npm') - .trim() - ) - } + if (fileExt === 'md') { + result = marked( + result.replace(/---([\s\S]+)---/g, '') + .replace(/(npm-)?([a-zA-Z\\.-]*)\(1\)/g, 'npm help $2') + .replace(/(npm-)?([a-zA-Z\\.-]*)\((5|7)\)/g, 'npm help $2') + .replace(/(npm-)?([a-zA-Z\\.-]*)\(3\)/g, 'npm apihelp $2') + .replace(/npm(1)/g, 'npm help npm') + .replace(/npm(3)/g, 'npm apihelp npm') + .trim() + ) + } fs.writeFile(dest, result, 'utf8', function (err) { - if (err) return console.log(err) + if (err) return console.log(err) }) - })