You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: website/README.md
+8-8
Original file line number
Diff line number
Diff line change
@@ -10,11 +10,11 @@ The website is generated by [Gatsby](https://www.gatsbyjs.org) and published to
10
10
11
11
The basic objective of this site is to publish additional useful information concerning the Node-API technology that extends beyond the basic documentation.
12
12
13
-
Ideally, pages published to this site should reference a working demo module that is also stored in this same repository. Features configured into the Gatsby project make embedding example source code fairly straightforward.
13
+
Ideally, pages published to this site should reference a working demo module that is also stored in this same repository. Features configured into the Gatsby project make embedding example source code fairly straightforward.
14
14
15
15
## Contributing
16
16
17
-
Submissions are gratefully accepted. Simply fork the [node-addon-examples](https://github.com/nodejs/node-addon-examples) repository containing this directory, make your changes, and submit a PR.
17
+
Submissions are gratefully accepted. Simply fork the [node-addon-examples](https://github.com/nodejs/node-addon-examples) repository containing this directory, make your changes, and submit a PR.
18
18
19
19
All of the site's content is located in the `docs` directory. Besides the Markdown files, there is also the `toc.json` file that needs to be updated when pages are added or removed.
20
20
@@ -29,11 +29,11 @@ Each of the Markdown files includes front matter that Gatsby uses when formattin
29
29
|`prev`| The `id` of the page to be shown as the Previous link at the bottom of the page. |
30
30
|`next`| The `id` of the page to be shown as the Next link at the bottom of the page. |
31
31
32
-
The `prev` and `next` links can be omitted for the first and last pages in the set, respectively.
32
+
The `prev` and `next` links can be omitted for the first and last pages in the set, respectively.
33
33
34
34
### Gatsby Basics
35
35
36
-
This project assumes that Gatsby is installed globally.
36
+
This project assumes that Gatsby is installed globally.
37
37
38
38
```
39
39
npm install -g gatsby-cli
@@ -56,17 +56,17 @@ These commands are useful while working on the site:
56
56
57
57
### Embedding Source Code Samples
58
58
59
-
For this project, Gatsby is configured to have the ability to copy example source code into the generated web pages. The advantage of this approach is that the web pages can be easily regenerated whenever the source code files change.
59
+
For this project, Gatsby is configured to have the ability to copy example source code into the generated web pages. The advantage of this approach is that the web pages can be easily regenerated whenever the source code files change.
60
60
61
61
Here's the pattern to follow for embedding example source code:
0 commit comments