

HelpViewer
A lightweight and simple reader for ZIP archives containing Markdown and HTML files, designed as a modern and portable help file viewer.
Cost / License
- Free
- Open Source (MIT)
Platforms
- Self-Hosted
- JavaScript
Features
Tags
- help-system
- offline-first
- Responsive design
- zipfile
- html
HelpViewer News & Activities
Recent activities
VitSimon added HelpViewer as alternative to Docsify.js, BookStack, GitBook and Docusaurus
HelpViewer information
What is HelpViewer?
How it works Try HelpViewer on your GitHub repository. Download the deployment package from package.zip and unzip it. 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. Alternatively, if you don't want to interfere with CORS, is to download a local HTTP server for Linux (Go/musl libc) or Windows, create a www folder in the server location, extract the HelpViewer installation into this folder, and start the server on localhost:8080 in your browser. Open the index.html file in your browser. 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. You will see e.g. the user documentation directly in HelpViewer, just like you are seeing this web page.



