From 7105bbc71072dbbdfa600d3981f10bbea4b3aa62 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Thu, 6 Jun 2019 19:48:16 -0700 Subject: [PATCH] doc: improve synopsis.md Many small improvements to synopsis.md to make it more concise, more clear, and more correct (punctuation, etc.). PR-URL: https://github.com/nodejs/node/pull/28115 Reviewed-By: Daniel Bevenius Reviewed-By: Beth Griggs Reviewed-By: Colin Ihrig Reviewed-By: Luigi Pinca Reviewed-By: Trivikram Kamat --- doc/api/synopsis.md | 31 ++++++++++--------------------- 1 file changed, 10 insertions(+), 21 deletions(-) diff --git a/doc/api/synopsis.md b/doc/api/synopsis.md index 599d6fab47e..5c4cb820e4d 100644 --- a/doc/api/synopsis.md +++ b/doc/api/synopsis.md @@ -5,31 +5,23 @@ `node [options] [V8 options] [script.js | -e "script" | - ] [arguments]` -Please see the [Command Line Options][] document for information about -different options and ways to run scripts with Node.js. +Please see the [Command Line Options][] document for more information. ## Example An example of a [web server][] written with Node.js which responds with `'Hello, World!'`: -Commands displayed in this document are shown starting with `$` or `>` -to replicate how they would appear in a user's terminal. -Do not include the `$` and `>` characters. They are there to -indicate the start of each command. +Commands in this document start with `$` or `>` to replicate how they would +appear in a user's terminal. Do not include the `$` and `>` characters. They are +there to show the start of each command. -There are many tutorials and examples that follow this -convention: `$` or `>` for commands run as a regular user, and `#` -for commands that should be executed as an administrator. +Lines that don’t start with `$` or `>` character show the output of the previous +command. -Lines that don’t start with `$` or `>` character are typically showing -the output of the previous command. - -Firstly, make sure to have downloaded and installed Node.js. -See [this guide][] for further install information. +First, make sure to have downloaded and installed Node.js. See [this guide][] +for further install information. Now, create an empty project folder called `projects`, then navigate into it. -The project folder can be named based on the user's current project title, but -this example will use `projects` as the project folder. Linux and Mac: @@ -75,14 +67,13 @@ server.listen(port, hostname, () => { }); ``` -Save the file, go back to the terminal window enter the following command: +Save the file, go back to the terminal window, and enter the following command: ```console $ node hello-world.js ``` -An output like this should appear in the terminal to indicate Node.js -server is running: +Output like this should appear in the terminal: ```console Server running at http://127.0.0.1:3000/ @@ -93,8 +84,6 @@ Now, open any preferred web browser and visit `http://127.0.0.1:3000`. If the browser displays the string `Hello, World!`, that indicates the server is working. -Many of the examples in the documentation can be run similarly. - [Command Line Options]: cli.html#cli_command_line_options [this guide]: https://nodejs.org/en/download/package-manager/ [web server]: http.html