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

cli: generate man-page #55268

Closed
wants to merge 7 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
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -767,6 +767,9 @@ doc-only: tools/doc/node_modules \
.PHONY: doc
doc: $(NODE_EXE) doc-only ## Build Node.js, and then build the documentation with the new binary.

doc/node.1: doc/api/cli.md
$(NODE) tools/lint-md/node_modules/.bin/api-docs-tooling -t man-page -i doc/api/cli.md -o doc/node.1

out/doc:
mkdir -p $@

Expand Down
14 changes: 14 additions & 0 deletions doc/api/esm.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@
<!-- YAML
added: v8.5.0
changes:
- version:
- v23.1.0
- v18.20.5
pr-url: https://github.com/nodejs/node/pull/55333
description: Import attributes are no longer experimental.
- version:
- v21.0.0
- v20.10.0
Expand Down Expand Up @@ -628,6 +633,15 @@ separate cache.

## JSON modules

<!-- YAML
changes:
- version:
- v23.1.0
- v18.20.5
pr-url: https://github.com/nodejs/node/pull/55333
description: JSON modules are no longer experimental.
-->

> Stability: 2 - Stable

JSON files can be referenced by `import`:
Expand Down
11 changes: 1 addition & 10 deletions doc/api/sqlite.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,7 @@ import sqlite from 'node:sqlite';
const sqlite = require('node:sqlite');
```

This module is only available under the `node:` scheme. The following will not
work:

```mjs
import sqlite from 'sqlite';
```

```cjs
const sqlite = require('sqlite');
```
This module is only available under the `node:` scheme.

The following example shows the basic usage of the `node:sqlite` module to open
an in-memory database, write data to the database, and then read the data back.
Expand Down
11 changes: 1 addition & 10 deletions doc/api/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,7 @@ import test from 'node:test';
const test = require('node:test');
```

This module is only available under the `node:` scheme. The following will not
work:

```mjs
import test from 'test';
```

```cjs
const test = require('test');
```
This module is only available under the `node:` scheme.

Tests created via the `test` module consist of a single function that is
processed in one of three ways:
Expand Down
Loading
Loading