-
Notifications
You must be signed in to change notification settings - Fork 30k
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
doc : being more explicit in the synopsis #17977
Changes from 3 commits
ab55bf3
2d75d3d
9e91b41
5427e5a
f42d3c2
bf4e20f
47cf571
54b63eb
3afa466
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,9 +9,71 @@ Please see the [Command Line Options][] document for information about | |
different options and ways to run scripts with Node.js. | ||
|
||
## Example | ||
|
||
An example of a [web server][] written with Node.js which responds with | ||
`'Hello World'`: | ||
`'Hello World!'`: | ||
|
||
We’ll be displaying a number of commands using a terminal, and those lines | ||
|
||
start with `$` or `>`. You don’t need to type in the `$` and `>` character; | ||
|
||
they are there to indicate the start of each command. | ||
|
||
You’ll see many tutorials and examples around the web that follow this | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Micro-nit (non-blocking, ignore if you disagree): remove |
||
|
||
convention: `$` or `>` for commands run as a regular user, and `#` | ||
|
||
for commands you should be running as an administrator. | ||
|
||
Lines that don’t start with `$` or `>` are typically showing the output of | ||
|
||
the previous command. | ||
|
||
Firstly, make sure you have downloaded Node.js from [Node.js Official website](http://nodejs.org/#download). | ||
|
||
If you want to install Node using a package manager, see [this guide](https://nodejs.org/en/download/package-manager/). | ||
|
||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nit: multiple lines are actually going to be shown as a single line in the output. The same applies to line 67. |
||
Now, create an empty project folder called `projects`, navigate into it: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you make it more clear that your folder doesn't have to be called
|
||
|
||
You can name your folder as you like or base on your current project title but | ||
|
||
we choose to use `projects` for the purpose of this example. | ||
|
||
Linux and Mac: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. May be UNIX rather than Linux and Mac ? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We usually go with There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
We seem to be using If we use Linux and MAC, it leaves an impression of either:
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @gireeshpunathil I'm convinced. Let's go with |
||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you include something like this:
(taken from https://doc.rust-lang.org/book/second-edition/ch01-01-installation.html#installation, feel free to reword it). There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @gibfahn Note my previous comments about personal pronouns. I wonder if this should really be a guide so that we don't have to worry about that sort of thing. Link to it from the docs? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you include something like this:
(taken from https://doc.rust-lang.org/book/second-edition/ch01-01-installation.html#installation, feel free to reword it). |
||
```txt | ||
$ mkdir ~/projects | ||
$ cd ~/projects | ||
``` | ||
Windows CMD: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It is always good to have a blank line before and after code / markdown blocks etc. |
||
```txt | ||
> mkdir %USERPROFILE%\projects | ||
> cd %USERPROFILE%\projects | ||
``` | ||
|
||
Windows PowerShell: | ||
|
||
```txt | ||
> mkdir $env:USERPROFILE\projects | ||
> cd $env:USERPROFILE\projects | ||
``` | ||
|
||
Next, create a new source file in the `projects` folder | ||
|
||
and call it `hello-world.js`. | ||
|
||
If you’re using more than one word in your filename, use an hyphen (`-`) or | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
an underscore(`_`) to separate them for simplicity and avoid using | ||
|
||
the space character in file names. | ||
|
||
For example, you’d use `hello-world.js` rather than `hello world.js`. | ||
Node.js files always end with the `.js` extension. | ||
|
||
Open `hello-world.js` in your favorite text editor and paste in the following | ||
content. | ||
|
||
|
||
```js | ||
const http = require('http'); | ||
|
@@ -22,21 +84,26 @@ const port = 3000; | |
const server = http.createServer((req, res) => { | ||
res.statusCode = 200; | ||
res.setHeader('Content-Type', 'text/plain'); | ||
res.end('Hello World\n'); | ||
res.end('Hello World!\n'); | ||
}); | ||
|
||
server.listen(port, hostname, () => { | ||
console.log(`Server running at http://${hostname}:${port}/`); | ||
}); | ||
``` | ||
|
||
To run the server, put the code into a file called `example.js` and execute | ||
it with Node.js: | ||
Save the file, go back to your terminal window enter the following command: | ||
|
||
```txt | ||
$ node example.js | ||
Server running at http://127.0.0.1:3000/ | ||
$ node hello-world.js | ||
``` | ||
you should see an output like this in your terminal to indicate Node.js | ||
server is running: | ||
``` | ||
Server running at http://127.0.0.1:3000/ | ||
```` | ||
Now, open your favorite browser and visit `http://127.0.0.1:3000`. | ||
|
||
You should see the string `Hello, world!`. | ||
|
||
Many of the examples in the documentation can be run similarly. | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docs are usually single-spaced. I'm not sure that double-spacing like this will render the same as other docs. Probably best to single-space it. (Blank lines between paragraphs are 👍 though!)