Skip to content

Commit bb4ae24

Browse files
authored
Update README with current Node.js and npm versions (#972)
1 parent 1eb260c commit bb4ae24

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
Swift-DocC-Render is a web Single Page Application (SPA) powered by [Vue.js](https://vuejs.org/) for creating rich code documentation websites. Pages and content are generated using render JSON data from DocC. It comes with a well suited design for documentation websites.
44
SPAs are web apps that render dynamically at runtime entirely in the browser, using JavaScript.
55

6-
[Swift-DocC](https://github.com/apple/swift-docc) is a tool for building and previewing documentation, aimed at making it easy to generate reference documentation from frameworks and packages, as well as free-form articles and tutorials authored in Markdown. It produces a folder in the Documentation Archive format (extension `.doccarchive`), which contains a machine-readable output of the documentation as JSON data that Swift-DocC-Render uses to produce rendered documentation.
6+
[Swift-DocC](https://github.com/swiftlang/swift-docc) is a tool for building and previewing documentation, aimed at making it easy to generate reference documentation from frameworks and packages, as well as free-form articles and tutorials authored in Markdown. It produces a folder in the Documentation Archive format (extension `.doccarchive`), which contains a machine-readable output of the documentation as JSON data that Swift-DocC-Render uses to produce rendered documentation.
77

88
## Getting Started
99

10-
> Note: requires [Node.js](https://nodejs.org/en/download/) v18
11-
> and [npm](https://www.npmjs.com/package/npm) v9.5. An easy way to set these up is to install
10+
> Note: requires [Node.js](https://nodejs.org/en/download/) v22.17.0
11+
> and [npm](https://www.npmjs.com/package/npm) v10.9.2. An easy way to set these up is to install
1212
> [nvm](https://github.com/nvm-sh/nvm) and run `nvm install` from within the Swift-DocC-Render
1313
> repository. To use these versions as the default, add `--default` to the installation command.
1414
@@ -37,7 +37,7 @@ SPAs are web apps that render dynamically at runtime entirely in the browser, us
3737
3838
## Using Swift-DocC-Render to render documentation
3939
40-
Follow [these steps](https://github.com/apple/swift-docc#using-docc-to-build-and-preview-documentation) to generate a documentation archive, set the path to your renderer and render locally your documentation using Swift-DocC-Render.
40+
Follow [these steps](https://github.com/swiftlang/swift-docc#using-docc-to-build-and-preview-documentation) to generate a documentation archive, set the path to your renderer and render locally your documentation using Swift-DocC-Render.
4141
4242
## Rendering and building docs
4343

0 commit comments

Comments
 (0)