Build locally
When your help is ready, you can run a local build to make sure there are no build errors and publish the help website manually.
In the Writerside tool window, click Export To and then select Web Archive.
If necessary, change the configuration name to something meaningful for you. This will make it easier to differentiate between several configurations if you have more than one.
By default, Writerside saves the archive to the root project directory. If necessary, change the location in the Save to field.
Click Run.
After a successful build, check the output for errors and warnings in the Run tool window.
Click Show generated files in a popup that appears in the bottom-right corner to open the directory with the archive.
You can create multiple run configurations to quickly generate help websites for various instances and outputs.
Run them from the configurations widget in the main toolbar:
Add more run configurations
Click Edit Configurations in the main toolbar widget or select from the main menu.
In the Run/Debug Configurations dialog, click Add New Configuration and add a new Writerside configuration.
To deploy your help locally, you can unpack the generated ZIP archive to a local directory and run a simple HTTP server in it. Or deploy the static help website to any web server.
Run on localhost
Download and install http-server.
Run the
http-server
command in the directory where you have unpacked the archive with the built help website. For example:http-server ~/my-helpOpen http://localhost:8080 in a web browser.
Dry run
If you are running local builds only to check for errors and warnings, you do not need the generated artifacts. In this case, you can enable the dry run mode that runs local builds without saving the ZIP archives with the help website.
Enable dry run
Press Ctrl+Shift+A, type
Registry
and open the Registry.In the Registry dialog, start typing
wrs
and enable the wrs.dry.run key.