Writerside Help

Build help 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.

  1. In the Writerside tool window, right-click the help instance you want to build, select Generate Website, and then click Save as ZIP archive.

  2. 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.

  3. By default, Writerside saves the archive to the root project directory. If necessary, change the location in the Save to field.

  4. Click Run.

    Save as ZIP archive
  5. After a successful build, check the output for errors and warnings in the Run tool window.

    Build errors displayed in the Run tool window
  6. Click Show generated files in a popup that appears in the bottom-right corner to open the directory with the archive.

To deploy your help locally, you can unpack the 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

  1. Download and install http-server.

  2. Run the http-server command in the directory where you have unpacked the archive with the built help website. For example:

    http-server ~/my-help
  3. Open http://localhost:8080 in a web browser.

Last modified: 10 October 2023