Skip to content

Commit

Permalink
chore(docs): fix links on markdowns
Browse files Browse the repository at this point in the history
chore(docs): fix styling issues on man and html docs

chore(docs): fix absolute links on cli docs
  • Loading branch information
claudiahdz committed Nov 14, 2019
1 parent 3471d52 commit b8c1576
Show file tree
Hide file tree
Showing 83 changed files with 259 additions and 203 deletions.
2 changes: 1 addition & 1 deletion docs/content/cli-commands/npm-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: npm-access
description: Set access level on published packages
---

# npm-access
# npm-access(1)

## Set access level on published packages

Expand Down
12 changes: 5 additions & 7 deletions docs/content/cli-commands/npm-adduser.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: npm-adduser
description: Set access level on published packages
---

# npm-adduser
# npm-adduser(1)

## Add a registry user account

Expand All @@ -20,7 +20,7 @@ aliases: login, add-user

Create or verify a user named `<username>` in the specified registry, and
save the credentials to the `.npmrc` file. If no registry is specified,
the default registry will be used (see [`npm-config`](npm-config)).
the default registry will be used (see [`config`](/using-npm/config)).

The username, password, and email are read in from prompts.

Expand All @@ -43,14 +43,14 @@ Default: https://registry.npmjs.org/

The base URL of the npm package registry. If `scope` is also specified,
this registry will only be used for packages with that scope. `scope` defaults
to the scope of the project directory you're currently in, if any. See [`npm-scope`](/docs/using-npm/scope).
to the scope of the project directory you're currently in, if any. See [`scope`](/using-npm/scope).

#### scope

Default: none

If specified, the user and login credentials given will be associated
with the specified scope. See [`npm-scope`](/docs/using-npm/scope). You can use both at the same time,
with the specified scope. See [`scope`](/using-npm/scope). You can use both at the same time,
e.g.

```bash
Expand All @@ -75,9 +75,7 @@ registries. Can be used with `--registry` and / or `--scope`, e.g.
This will ensure that all requests to that registry (including for tarballs)
include an authorization header. This setting may be necessary for use with
private registries where metadata and package tarballs are stored on hosts with
different hostnames. See `always-auth` in [`npm-config`](/docs/using-npm/config) for more details on
always-auth. Registry-specific configuration of `always-auth` takes precedence
over any global configuration.
different hostnames. See `always-auth` in [`config`](/using-npm/config) for more details on always-auth. Registry-specific configuration of `always-auth` takes precedence over any global configuration.

#### auth-type

Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli-commands/npm-audit.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: npm-audit
description: Run a security audit
---

# npm-audit
# npm-audit(1)

## Run a security audit

Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli-commands/npm-bin.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: npm-bin
description: Display npm bin folder
---

# npm-bin
# npm-bin(1)

## Display npm bin folder

Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli-commands/npm-bugs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: npm-bugs
description: Bugs for a package in a web browser maybe
---

# npm-bugs
# npm-bugs(1)

## Bugs for a package in a web browser maybe

Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli-commands/npm-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: npm-build
description: Build a package
---

# npm-build
# npm-build(1)

## Build a package

Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli-commands/npm-bundle.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: npm-bundle
description: REMOVED
---

# npm-bundle
# npm-bundle(1)

## REMOVED

Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli-commands/npm-cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: npm-cache
description: Manipulates packages cache
---

# npm-cache
# npm-cache(1)

## Manipulates packages cache

Expand Down
4 changes: 2 additions & 2 deletions docs/content/cli-commands/npm-ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: npm-ci
description: Install a project with a clean slate
---

# npm-ci
# npm-ci(1)

## Install a project with a clean slate

Expand Down Expand Up @@ -45,7 +45,7 @@ cache:

### Description

This command is similar to [`npm-install`](npm-install), except it's meant to be used in
This command is similar to [`npm install`](/cli-commands/npm-install), except it's meant to be used in
automated environments such as test platforms, continuous integration, and
deployment -- or any situation where you want to make sure you're doing a clean
install of your dependencies. It can be significantly faster than a regular npm
Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli-commands/npm-completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: npm-completion
description: Tab Completion for npm
---

# npm-completion
# npm-completion(1)

## Tab Completion for npm

Expand Down
6 changes: 3 additions & 3 deletions docs/content/cli-commands/npm-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: npm-config
description: Manage the npm configuration files
---

# npm-config
# npm-config(1)

## Manage the npm configuration files

Expand All @@ -26,9 +26,9 @@ aliases: c
npm gets its config settings from the command line, environment
variables, `npmrc` files, and in some cases, the `package.json` file.

See [npmrc](/docs/configuring-npm/npmrc) for more information about the npmrc files.
See [npmrc](/configuring-npm/npmrc) for more information about the npmrc files.

See [config](/docs/using-npm/config) for a more thorough discussion of the mechanisms
See [config](/using-npm/config) for a more thorough discussion of the mechanisms
involved.

The `npm config` command can be used to update and edit the contents
Expand Down
4 changes: 2 additions & 2 deletions docs/content/cli-commands/npm-dedupe.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: npm-dedupe
description: Reduce duplication
---

# npm-dedupe
# npm-dedupe(1)

## Reduce duplication

Expand Down Expand Up @@ -32,7 +32,7 @@ a
`-- c@1.0.10
```

In this case, `npm-dedupe` will transform the tree to:
In this case, `npm dedupe` will transform the tree to:

```bash
a
Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli-commands/npm-deprecate.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ section: cli-commands
title: npm-deprecate
description: Deprecate a version of a package
---
# npm-deprecate
# npm-deprecate(1)

## Deprecate a version of a package

Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli-commands/npm-dist-tag.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: npm-dist-tag
description: Modify package distribution tags
---

# npm-dist-tag
# npm-dist-tag(1)

## Modify package distribution tags

Expand Down
3 changes: 1 addition & 2 deletions docs/content/cli-commands/npm-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,10 @@ title: npm-docs
description: Docs for a package in a web browser maybe
---

# npm-docs
# npm-docs(1)

## Docs for a package in a web browser maybe


### Synopsis

```bash
Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli-commands/npm-doctor.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: npm-doctor
description: Check your environments
---

# npm-doctor
# npm-doctor(1)

## Check your environments

Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli-commands/npm-edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: npm-edit
description: Edit an installed package
---

# npm-edit
# npm-edit(1)

## Edit an installed package

Expand Down
4 changes: 2 additions & 2 deletions docs/content/cli-commands/npm-explore.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ title: npm-explore
description: Browse an installed package
---

# npm-explore
# npm-explore(1)

## description: Browse an installed package
## Browse an installed package

### Synopsis

Expand Down
10 changes: 5 additions & 5 deletions docs/content/cli-commands/npm-fund.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: npm-fund
description: Retrieve funding information
---

# npm-fund
# npm-fund(1)

## Retrieve funding information

Expand Down Expand Up @@ -53,8 +53,8 @@ Set it to `false` in order to use all-ansi output.

## See Also

* [npm-docs](/cli-commands/npm-docs)
* [npm-config](/cli-commands/npm-config)
* [npm-install](/cli-commands/npm-install)
* [npm-ls](/cli-commands/npm-ls)
* [npm docs](/cli-commands/npm-docs)
* [npm config](/cli-commands/npm-config)
* [npm install](/cli-commands/npm-install)
* [npm ls](/cli-commands/npm-ls)

2 changes: 1 addition & 1 deletion docs/content/cli-commands/npm-help-search.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: npm-help-search
description: Search npm help documentation
---

# npm-help-search
# npm-help-search(1)

## Search npm help documentation

Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli-commands/npm-help.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: npm-help
description: Get help on npm
---

# npm-help
# npm-help(1)

## Get help on npm

Expand Down
5 changes: 2 additions & 3 deletions docs/content/cli-commands/npm-hook.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: npm-hook
description: Manage registry hooks
---

# npm-hook
# npm-hook(1)

## Manage registry hooks

Expand Down Expand Up @@ -56,8 +56,7 @@ $ npm hook rm id-deadbeef

### Description

Allows you to manage [npm
hooks](https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm),
Allows you to manage [npm hooks](https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm),
including adding, removing, listing, and updating.

Hooks allow you to configure URL endpoints that will be notified whenever a
Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli-commands/npm-init.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: npm-init
description: create a package.json file
---

# npm-init
# npm-init(1)

## create a package.json file

Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli-commands/npm-install-ci-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: npm-install-ci-test
description: Install a project with a clean slate and run tests
---

# npm install-ci-test
# npm install-ci-test(1)

## Install a project with a clean slate and run tests

Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli-commands/npm-install-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: npm-install-test
description: Install package(s) and run tests
---

# npm install-test
# npm install-test(1)

## Install package(s) and run tests

Expand Down
Loading

0 comments on commit b8c1576

Please sign in to comment.