Skip to content

Commit 810e08b

Browse files
fix: The server parameter deprecated and will be remove in next Major version fixed #1413
BREAKING CHANGE: The serve parametr was remove, you can use any other tools which could be refresh and store your html site The private parameter has removed, use a access
1 parent 9da4567 commit 810e08b

File tree

10 files changed

+20
-559
lines changed

10 files changed

+20
-559
lines changed

README.md

+19-26
Original file line numberDiff line numberDiff line change
@@ -14,28 +14,28 @@
1414

1515
[:date: Current maintenance status](https://github.com/documentationjs/documentation/wiki/Current-maintenance-status)
1616

17-
* Supports modern JavaScript: ES5, ES2017, JSX, Vue and [Flow](https://flow.org/) type annotations.
18-
* Infers parameters, types, membership, and more. Write less documentation: let the computer write it for you.
19-
* Integrates with GitHub to link directly from documentation to the code it refers to.
20-
* Customizable output: HTML, JSON, Markdown, and more
17+
- Supports modern JavaScript: ES5, ES2017, JSX, Vue and [Flow](https://flow.org/) type annotations.
18+
- Infers parameters, types, membership, and more. Write less documentation: let the computer write it for you.
19+
- Integrates with GitHub to link directly from documentation to the code it refers to.
20+
- Customizable output: HTML, JSON, Markdown, and more
2121

2222
## Examples
2323

24-
- [HTML output with default template](https://documentation.js.org/html-example/)
25-
- [Markdown](https://github.com/documentationjs/documentation/blob/master/docs/NODE_API.md)
26-
- [JSON](https://documentation.js.org/html-example/index.json)
24+
- [HTML output with default template](https://documentation.js.org/html-example/)
25+
- [Markdown](https://github.com/documentationjs/documentation/blob/master/docs/NODE_API.md)
26+
- [JSON](https://documentation.js.org/html-example/index.json)
2727

2828
## Documentation
2929

30-
- [Getting Started](docs/GETTING_STARTED.md): start here
31-
- [Usage](docs/USAGE.md): how to use documentation.js
32-
- [Recipes](docs/RECIPES.md): tricks for writing effective JSDoc docs
33-
- [Node API](docs/NODE_API.md): documentation.js's self-generated documentation
34-
- [Configuring documentation.js](docs/CONFIG.md)
35-
- [FAQ](docs/FAQ.md)
36-
- [Troubleshooting](docs/TROUBLESHOOTING.md)
37-
- [Theming](docs/THEMING.md): tips for theming documentation output in HTML
38-
- [See also](https://github.com/documentationjs/documentation/wiki/See-also): a list of projects similar to documentation.js
30+
- [Getting Started](docs/GETTING_STARTED.md): start here
31+
- [Usage](docs/USAGE.md): how to use documentation.js
32+
- [Recipes](docs/RECIPES.md): tricks for writing effective JSDoc docs
33+
- [Node API](docs/NODE_API.md): documentation.js's self-generated documentation
34+
- [Configuring documentation.js](docs/CONFIG.md)
35+
- [FAQ](docs/FAQ.md)
36+
- [Troubleshooting](docs/TROUBLESHOOTING.md)
37+
- [Theming](docs/THEMING.md): tips for theming documentation output in HTML
38+
- [See also](https://github.com/documentationjs/documentation/wiki/See-also): a list of projects similar to documentation.js
3939

4040
## User Guide
4141

@@ -62,12 +62,6 @@ documentation build src/** -f html --github -o docs
6262
# document index.js, ignoring any files it requires or imports
6363
documentation build index.js -f md --shallow
6464

65-
# build and serve HTML docs for app.js
66-
documentation serve app.js
67-
68-
# build, serve, and live-update HTML docs for app.js
69-
documentation serve --watch app.js
70-
7165
# validate JSDoc syntax in util.js
7266
documentation lint util.js
7367

@@ -81,7 +75,6 @@ documentation build --document-exported index.js
8175
documentation build index.ts --parse-extension ts -f html -o docs
8276

8377
Commands:
84-
serve [input..] generate, update, and display HTML documentation
8578
build [input..] build documentation
8679
lint [input..] check for common style and uniformity mistakes
8780
readme [input..] inject documentation into your README.md
@@ -97,9 +90,9 @@ _We have plenty of
9790
[issues](https://github.com/documentationjs/documentation/issues) that we'd
9891
love help with._
9992

100-
- Robust and complete `JSDoc` support, including typedefs.
101-
- Strong support for HTML and Markdown output
102-
- Documentation coverage, statistics, and validation
93+
- Robust and complete `JSDoc` support, including typedefs.
94+
- Strong support for HTML and Markdown output
95+
- Documentation coverage, statistics, and validation
10396

10497
documentation is an OPEN Open Source Project. This means that:
10598

__tests__/lib/__snapshots__/server.js.snap

-7
This file was deleted.

__tests__/lib/server.js

-59
This file was deleted.

bin/documentation.js

-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ import commands from '../src/commands/index.js';
88

99
yargs(hideBin(process.argv))
1010
.strict()
11-
.command(commands.serve)
1211
.command(commands.build)
1312
.command(commands.lint)
1413
.command(commands.readme)

0 commit comments

Comments
 (0)