File tree Expand file tree Collapse file tree 1 file changed +8
-3
lines changed
Expand file tree Collapse file tree 1 file changed +8
-3
lines changed Original file line number Diff line number Diff line change @@ -61,16 +61,21 @@ wiki {
6161
6262## Real-time documentation preview
6363
64- The plugin allows you to preview your mod documentation in real-time on your local machine. Behind the scenes,
65- this is done by cloning the Wiki's GitHub repository and enabling local preview mode.
64+ The plugin allows you to preview your mod documentation in real-time on your local machine.
6665
67- Running a local preview requires [ NodeJS] ( https://nodejs.org/en/download/ ) and [ pnpm] ( https://pnpm.io/installation ) .
66+ Running a local preview requires [ NodeJS] ( https://nodejs.org/en/download/ ) and
67+ [ npm] ( https://docs.npmjs.com/downloading-and-installing-node-js-and-npm ) .
6868Please make sure you have NodeJS ** v20 or above** installed on your computer.
6969
7070** To start the local preview, run the ` previewDocs ` task.** This will set up and launch the local wiki environment.
7171
7272Once ready, it will be available at ` http://localhost:3000 ` .
7373
74+ ### Standalone preview
75+
76+ You can also run the previewer separately from the plugin. See the
77+ [ NPM package] ( https://www.npmjs.com/package/@sinytra/wiki-previewer ) for more information.
78+
7479### Known issues
7580
7681Using ` org.gradle.daemon=false ` will prevent the npm task from existing when gradle is stopped, keeping it running
You can’t perform that action at this time.
0 commit comments