Skip to content

Commit

Permalink
More precision in what version of Node is necessary for building the …
Browse files Browse the repository at this point in the history
…docs
  • Loading branch information
squeek502 committed Jun 17, 2021
1 parent 72a805d commit 4f2597d
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: '10'
node-version: '12.18.2'

- name: Build
run: cd docs && ./make.sh
Expand Down
5 changes: 2 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,11 @@ d2itemreader's documentation uses a combination of:
- [A fork of moxygen](https://github.com/squeek502/moxygen) to generate Markdown from the Doxygen XML file
- [gitbook-cli](https://www.npmjs.com/package/gitbook-cli) to generate the final static docs combining the generated API Markdown with the static Markdown files in the docs directory

**Note: gitbook-cli is no longer receiving updates and does not seem to work with versions of Node.js newer than 10.x**

## Building

First, you'll need to have the following installed and accessible via `PATH`:
- [node.js 10.x and npm](https://nodejs.org/)
- [node.js v12.18.2 or earlier and npm](https://nodejs.org/)
+ **Note: gitbook-cli is no longer receiving updates and is incompatible with Node v12.18.3 or later**
- [Doxygen](http://www.doxygen.nl/)

### On Windows
Expand Down

0 comments on commit 4f2597d

Please sign in to comment.