Skip to content

fix links and newlines in getting started #165

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.

Sign up for GitHub

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

Merged
mhdawson merged 1 commit into from
Nov 27, 2020
Merged

fix links and newlines in getting started #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion website/docs/getting-started/first.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ prev: getting-started.tools
next: getting-started.objectwrap
---

Before you start, make sure you've got all the necessary [prerequisites](prerequisites.html) and [tools](tools.html) installed.
Before you start, make sure you've got all the necessary [prerequisites](prerequisites) and [tools](tools) installed.

As you select where to begin, you should be aware that N-API operates at two levels which we can think of as the "C level" and the "C++ level".

Expand Down
2 changes: 1 addition & 1 deletion website/docs/getting-started/helloworld.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: Hello, world!

This tutorial will walk you through the process of creating a simple N-API module from scratch. It requires no dependencies beyond Node and npm itself.

Before you start, make sure you've got all the necessary [prerequisites](prerequisites.html) and [tools](tools.html) installed.
Before you start, make sure you've got all the necessary [prerequisites](prerequisites) and [tools](tools) installed.

As you select where to begin, you should be aware that N-API operates at two levels which we can think of as the "C level" and the "C++ level".

Expand Down
4 changes: 2 additions & 2 deletions website/docs/getting-started/migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This tutorial uses the conversion tool supplied with N-API to give you a head st

To keep things somewhat constrained, this tutorial uses [node-microtime](https://github.com/wadey/node-microtime) which is a simple NAN-based native add-on. This add-on makes system calls to determine the current time to microsecond resolution if supported by the operating system.

Before you start, make sure you've got all the necessary [prerequisites](prerequisites.html) and [tools](tools.html) installed.
Before you start, make sure you've got all the necessary [prerequisites](prerequisites) and [tools](tools) installed.

> N-API has been in public release and active development starting with Node 8.0.0. Since then, it's undergone a number of refinements. This tutorial has been tested with Node 10.1.0 and is known to fail with older versions of Node. You can determine the version of Node you're running with the command `node -v`.

Expand Down Expand Up @@ -177,4 +177,4 @@ There are number of good resources to help you better understand N-API as you mi

[node-addon-api Test Code](https://github.com/nodejs/node-addon-api/tree/master/test)

Each of these resources is maintained by the N-API Team.
Each of these resources is maintained by the N-API Team.
4 changes: 2 additions & 2 deletions website/docs/getting-started/objectwrap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ prev: getting-started.first
next: getting-started.migration
---

This tutorial is an alternative to [A first project](./first.html) that generates a more complex project. Instead of generating a simple function binding, this project demonstrates how to create a JavaScript object from a C++ object.
This tutorial is an alternative to [A first project](first) that generates a more complex project. Instead of generating a simple function binding, this project demonstrates how to create a JavaScript object from a C++ object.

Before you start, make sure you've got all the necessary [prerequisites](prerequisites.html) and [tools](tools.html) installed.
Before you start, make sure you've got all the necessary [prerequisites](prerequisites) and [tools](tools) installed.

As you select where to begin, you should be aware that N-API operates at two levels which we can think of as the "C level" and the "C++ level".

Expand Down
2 changes: 1 addition & 1 deletion website/docs/getting-started/prerequisites.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ For your own projects, it will be necessary to have an understanding of the C/C+

## Command line tools

Many of the tools used to develop N-API modules are run from the command line. So at least a passing familiarity and confidence with your command line tool is essential. IDEs, as described [here](tools.html#Other-tools) can help. But they also rely in the command line.
Many of the tools used to develop N-API modules are run from the command line. So at least a passing familiarity and confidence with your command line tool is essential. IDEs, as described [here](tools#other-tools) can help. But they also rely in the command line.
2 changes: 1 addition & 1 deletion website/docs/getting-started/tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,4 +97,4 @@ You'll need your favorite shell program which typically comes pre-installed on m

And you'll need your favorite code editor.

There are also powerful IDEs (Integrated Development Environments) that are popular in the developer community. Among these are [Visual Studio Code](https://code.visualstudio.com) and [WebStorm](https://www.jetbrains.com/webstorm/). Depending upon your level of involvement with this work, these tools can quickly pay for themselves in increased productivity.
There are also powerful IDEs (Integrated Development Environments) that are popular in the developer community. Among these are [Visual Studio Code](https://code.visualstudio.com) and [WebStorm](https://www.jetbrains.com/webstorm/). Depending upon your level of involvement with this work, these tools can quickly pay for themselves in increased productivity.