Writerside Help

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.

  1. In the Writerside tool window, click Export To Export To and then select Web Archive.

    Build instance locally
  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.

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:

Run configurations widget

Add more run configurations

  1. Click Edit Configurations in the main toolbar widget or select Run | Edit Configurations from the main menu.

  2. In the Run/Debug Configurations dialog, click Add New Configuration 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

  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.

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

  1. Press Ctrl+Shift+A, type Registry and open the Registry.

  2. In the Registry dialog, start typing wrs and enable the wrs.dry.run key.

Last modified: 23 May 2024