Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[v10.x backport] doc: allow <code> in header elements #31109

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 37 additions & 37 deletions doc/api/dns.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ dns.resolve4('archive.org', (err, addresses) => {
There are subtle consequences in choosing one over the other, please consult
the [Implementation considerations section][] for more information.

## Class: dns.Resolver
## Class: `dns.Resolver`
<!-- YAML
added: v8.3.0
-->
Expand Down Expand Up @@ -97,15 +97,15 @@ The following methods from the `dns` module are available:
* [`resolver.reverse()`][`dns.reverse()`]
* [`resolver.setServers()`][`dns.setServers()`]

### resolver.cancel()
### `resolver.cancel()`
<!-- YAML
added: v8.3.0
-->

Cancel all outstanding DNS queries made by this resolver. The corresponding
callbacks will be called with an error with code `ECANCELLED`.

## dns.getServers()
## `dns.getServers()`
<!-- YAML
added: v0.11.3
-->
Expand All @@ -126,7 +126,7 @@ section if a custom port is used.
]
```

## dns.lookup(hostname[, options], callback)
## `dns.lookup(hostname[, options], callback)`
<!-- YAML
added: v0.1.90
changes:
Expand Down Expand Up @@ -212,7 +212,7 @@ configured. Loopback addresses are not considered.
found, then return IPv4 mapped IPv6 addresses. Note that it is not supported
on some operating systems (e.g FreeBSD 10.1).

## dns.lookupService(address, port, callback)
## `dns.lookupService(address, port, callback)`
<!-- YAML
added: v0.11.14
-->
Expand Down Expand Up @@ -243,7 +243,7 @@ dns.lookupService('127.0.0.1', 22, (err, hostname, service) => {
If this method is invoked as its [`util.promisify()`][]ed version, it returns a
`Promise` for an `Object` with `hostname` and `service` properties.

## dns.resolve(hostname[, rrtype], callback)
## `dns.resolve(hostname[, rrtype], callback)`
<!-- YAML
added: v0.1.27
-->
Expand Down Expand Up @@ -275,7 +275,7 @@ records. The type and structure of individual results varies based on `rrtype`:
On error, `err` is an [`Error`][] object, where `err.code` is one of the
[DNS error codes](#dns_error_codes).

## dns.resolve4(hostname[, options], callback)
## `dns.resolve4(hostname[, options], callback)`
<!-- YAML
added: v0.1.16
changes:
Expand All @@ -299,7 +299,7 @@ Uses the DNS protocol to resolve a IPv4 addresses (`A` records) for the
will contain an array of IPv4 addresses (e.g.
`['74.125.79.104', '74.125.79.105', '74.125.79.106']`).

## dns.resolve6(hostname[, options], callback)
## `dns.resolve6(hostname[, options], callback)`
<!-- YAML
added: v0.1.16
changes:
Expand All @@ -322,7 +322,7 @@ Uses the DNS protocol to resolve a IPv6 addresses (`AAAA` records) for the
`hostname`. The `addresses` argument passed to the `callback` function
will contain an array of IPv6 addresses.

## dns.resolveAny(hostname, callback)
## `dns.resolveAny(hostname, callback)`

* `hostname` {string}
* `callback` {Function}
Expand Down Expand Up @@ -371,7 +371,7 @@ DNS server operators may choose not to respond to `ANY`
queries. It may be better to call individual methods like [`dns.resolve4()`][],
[`dns.resolveMx()`][], and so on. For more details, see [RFC 8482][].

## dns.resolveCname(hostname, callback)
## `dns.resolveCname(hostname, callback)`
<!-- YAML
added: v0.3.2
-->
Expand All @@ -385,7 +385,7 @@ Uses the DNS protocol to resolve `CNAME` records for the `hostname`. The
will contain an array of canonical name records available for the `hostname`
(e.g. `['bar.example.com']`).

## dns.resolveMx(hostname, callback)
## `dns.resolveMx(hostname, callback)`
<!-- YAML
added: v0.1.27
-->
Expand All @@ -399,7 +399,7 @@ Uses the DNS protocol to resolve mail exchange records (`MX` records) for the
contain an array of objects containing both a `priority` and `exchange`
property (e.g. `[{priority: 10, exchange: 'mx.example.com'}, ...]`).

## dns.resolveNaptr(hostname, callback)
## `dns.resolveNaptr(hostname, callback)`
<!-- YAML
added: v0.9.12
-->
Expand Down Expand Up @@ -431,7 +431,7 @@ function will contain an array of objects with the following properties:
}
```

## dns.resolveNs(hostname, callback)
## `dns.resolveNs(hostname, callback)`
<!-- YAML
added: v0.1.90
-->
Expand All @@ -445,7 +445,7 @@ Uses the DNS protocol to resolve name server records (`NS` records) for the
contain an array of name server records available for `hostname`
(e.g. `['ns1.example.com', 'ns2.example.com']`).

## dns.resolvePtr(hostname, callback)
## `dns.resolvePtr(hostname, callback)`
<!-- YAML
added: v6.0.0
-->
Expand All @@ -458,7 +458,7 @@ Uses the DNS protocol to resolve pointer records (`PTR` records) for the
`hostname`. The `addresses` argument passed to the `callback` function will
be an array of strings containing the reply records.

## dns.resolveSoa(hostname, callback)
## `dns.resolveSoa(hostname, callback)`
<!-- YAML
added: v0.11.10
-->
Expand Down Expand Up @@ -492,7 +492,7 @@ be an object with the following properties:
}
```

## dns.resolveSrv(hostname, callback)
## `dns.resolveSrv(hostname, callback)`
<!-- YAML
added: v0.1.27
-->
Expand Down Expand Up @@ -520,7 +520,7 @@ be an array of objects with the following properties:
}
```

## dns.resolveTxt(hostname, callback)
## `dns.resolveTxt(hostname, callback)`
<!-- YAML
added: v0.1.27
-->
Expand All @@ -536,7 +536,7 @@ two-dimensional array of the text records available for `hostname` (e.g.
one record. Depending on the use case, these could be either joined together or
treated separately.

## dns.reverse(ip, callback)
## `dns.reverse(ip, callback)`
<!-- YAML
added: v0.1.16
-->
Expand All @@ -551,7 +551,7 @@ array of hostnames.
On error, `err` is an [`Error`][] object, where `err.code` is
one of the [DNS error codes][].

## dns.setServers(servers)
## `dns.setServers(servers)`
<!-- YAML
added: v0.11.3
-->
Expand Down Expand Up @@ -594,7 +594,7 @@ The `dns.promises` API provides an alternative set of asynchronous DNS methods
that return `Promise` objects rather than using callbacks. The API is accessible
via `require('dns').promises`.

### Class: dnsPromises.Resolver
### Class: `dnsPromises.Resolver`
<!-- YAML
added: v10.6.0
-->
Expand Down Expand Up @@ -640,7 +640,7 @@ The following methods from the `dnsPromises` API are available:
* [`resolver.reverse()`][`dnsPromises.reverse()`]
* [`resolver.setServers()`][`dnsPromises.setServers()`]

### dnsPromises.getServers()
### `dnsPromises.getServers()`
<!-- YAML
added: v10.6.0
-->
Expand All @@ -661,7 +661,7 @@ section if a custom port is used.
]
```

### dnsPromises.lookup(hostname[, options])
### `dnsPromises.lookup(hostname[, options])`
<!-- YAML
added: v10.6.0
-->
Expand Down Expand Up @@ -724,7 +724,7 @@ dnsPromises.lookup('example.com', options).then((result) => {
});
```

### dnsPromises.lookupService(address, port)
### `dnsPromises.lookupService(address, port)`
<!-- YAML
added: v10.6.0
-->
Expand All @@ -749,7 +749,7 @@ dnsPromises.lookupService('127.0.0.1', 22).then((result) => {
});
```

### dnsPromises.resolve(hostname[, rrtype])
### `dnsPromises.resolve(hostname[, rrtype])`
<!-- YAML
added: v10.6.0
-->
Expand Down Expand Up @@ -778,7 +778,7 @@ based on `rrtype`:
On error, the `Promise` is rejected with an [`Error`][] object, where `err.code`
is one of the [DNS error codes](#dns_error_codes).

### dnsPromises.resolve4(hostname[, options])
### `dnsPromises.resolve4(hostname[, options])`
<!-- YAML
added: v10.6.0
-->
Expand All @@ -793,7 +793,7 @@ Uses the DNS protocol to resolve IPv4 addresses (`A` records) for the
`hostname`. On success, the `Promise` is resolved with an array of IPv4
addresses (e.g. `['74.125.79.104', '74.125.79.105', '74.125.79.106']`).

### dnsPromises.resolve6(hostname[, options])
### `dnsPromises.resolve6(hostname[, options])`
<!-- YAML
added: v10.6.0
-->
Expand All @@ -808,7 +808,7 @@ Uses the DNS protocol to resolve IPv6 addresses (`AAAA` records) for the
`hostname`. On success, the `Promise` is resolved with an array of IPv6
addresses.

### dnsPromises.resolveAny(hostname)
### `dnsPromises.resolveAny(hostname)`
<!-- YAML
added: v10.6.0
-->
Expand Down Expand Up @@ -852,7 +852,7 @@ Here is an example of the result object:
minttl: 60 } ]
```

### dnsPromises.resolveCname(hostname)
### `dnsPromises.resolveCname(hostname)`
<!-- YAML
added: v10.6.0
-->
Expand All @@ -862,7 +862,7 @@ Uses the DNS protocol to resolve `CNAME` records for the `hostname`. On success,
the `Promise` is resolved with an array of canonical name records available for
the `hostname` (e.g. `['bar.example.com']`).

### dnsPromises.resolveMx(hostname)
### `dnsPromises.resolveMx(hostname)`
<!-- YAML
added: v10.6.0
-->
Expand All @@ -873,7 +873,7 @@ Uses the DNS protocol to resolve mail exchange records (`MX` records) for the
containing both a `priority` and `exchange` property (e.g.
`[{priority: 10, exchange: 'mx.example.com'}, ...]`).

### dnsPromises.resolveNaptr(hostname)
### `dnsPromises.resolveNaptr(hostname)`
<!-- YAML
added: v10.6.0
-->
Expand Down Expand Up @@ -902,7 +902,7 @@ of objects with the following properties:
}
```

### dnsPromises.resolveNs(hostname)
### `dnsPromises.resolveNs(hostname)`
<!-- YAML
added: v10.6.0
-->
Expand All @@ -913,7 +913,7 @@ Uses the DNS protocol to resolve name server records (`NS` records) for the
records available for `hostname` (e.g.
`['ns1.example.com', 'ns2.example.com']`).

### dnsPromises.resolvePtr(hostname)
### `dnsPromises.resolvePtr(hostname)`
<!-- YAML
added: v10.6.0
-->
Expand All @@ -923,7 +923,7 @@ Uses the DNS protocol to resolve pointer records (`PTR` records) for the
`hostname`. On success, the `Promise` is resolved with an array of strings
containing the reply records.

### dnsPromises.resolveSoa(hostname)
### `dnsPromises.resolveSoa(hostname)`
<!-- YAML
added: v10.6.0
-->
Expand Down Expand Up @@ -954,7 +954,7 @@ following properties:
}
```

### dnsPromises.resolveSrv(hostname)
### `dnsPromises.resolveSrv(hostname)`
<!-- YAML
added: v10.6.0
-->
Expand All @@ -979,7 +979,7 @@ the following properties:
}
```

### dnsPromises.resolveTxt(hostname)
### `dnsPromises.resolveTxt(hostname)`
<!-- YAML
added: v10.6.0
-->
Expand All @@ -992,7 +992,7 @@ of the text records available for `hostname` (e.g.
one record. Depending on the use case, these could be either joined together or
treated separately.

### dnsPromises.reverse(ip)
### `dnsPromises.reverse(ip)`
<!-- YAML
added: v10.6.0
-->
Expand All @@ -1004,7 +1004,7 @@ array of hostnames.
On error, the `Promise` is rejected with an [`Error`][] object, where `err.code`
is one of the [DNS error codes](#dns_error_codes).

### dnsPromises.setServers(servers)
### `dnsPromises.setServers(servers)`
<!-- YAML
added: v10.6.0
-->
Expand Down
30 changes: 20 additions & 10 deletions doc/api_assets/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,28 @@ body {
background: #fff;
}

h1 { font-size: 2.5rem }
h2 { font-size: 2rem }
h3 { font-size: 1.75rem }
h4 { font-size: 1.5rem }
h5 { font-size: 1.25rem }
h6 { font-size: 1rem }

h1, h2, h3, h4, h5, h6 {
margin: 1.5rem 0 1rem;
text-rendering: optimizeLegibility;
h1, h1 code { font-size: 2.5rem; }
h2, h2 code { font-size: 2rem; }
h3, h3 code { font-size: 1.75rem; }
h4, h4 code { font-size: 1.5rem; }
h5, h5 code { font-size: 1.25rem; }
h6, h6 code { font-size: 1rem; }

h1, h1 code,
h2, h2 code,
h3, h3 code,
h4, h4 code,
h5, h5 code,
h6, h6 code {
background-color: inherit;
color: inherit;
font-family: inherit;
font-weight: 700;
line-height: inherit;
margin: 1.5rem 0 1rem;
padding: inherit;
position: relative;
text-rendering: optimizeLegibility;
}

pre, tt, code, .pre, span.type, a.type {
Expand Down