🌐HelpViewer

is a modern, portable and fast tool for viewing Markdown and HTML documentation directly from ZIP archives or from a local directory where they have been unpacked. No server or backend required - just open the index.html in your browser. MIT licensed.

How it works #

1. Download the deployment package from package.zip and unzip it.
2. For correct display, launch the browser without CORS restrictions. Otherwise, you will see a page with message and have to manually select help and data files.
3. Open the index.html file in your browser.
4. Set the URL parameter ?d=X, where X is the path to your ZIP file or you can define path ending with / if you want to read a directory.
   If you skip this step, ./hlp/Help-{current language}.zip will be used by default.
5. You will see e.g. the user documentation directly in HelpViewer, just like you are seeing this web page.

Used 3rd party products #

• JSZip library (under MIT)
• Marked (under MIT)
• Mermaid (under MIT)
• Prism (under MIT)