-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathREADME.htm
More file actions
1 lines (1 loc) · 5.7 KB
/
README.htm
File metadata and controls
1 lines (1 loc) · 5.7 KB
1
<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1"><title>🌐HelpViewer</title><meta name="description" content="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 unpack"><link rel="icon" type="image/png" href="favicon.png"><meta property="og:title" content="🌐HelpViewer"><meta property="og:description" content="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 unpack"><meta property="og:type" content="website"><meta property="og:image" content="favicon.png"><meta name="robots" content="index,follow"><link rel="stylesheet" href="src/i-formsupport-css.css" type="text/css"><link rel="stylesheet" href="src/mainCSS.css" type="text/css"><link rel="stylesheet" href="src/mainCSSPlus.css" type="text/css"><link rel="stylesheet" href="src/addition-puiWatermark-toc.css" type="text/css"><link rel="stylesheet" href="src/admonitions.css.css" type="text/css"><link rel="stylesheet" href="src/overridePlusMinusVars.css" type="text/css"><link rel="stylesheet" href="src/prism/prism.css.css" type="text/css"><link rel="stylesheet" href="src/prism/override.css.css" type="text/css"><link rel="stylesheet" href="src/TPL-HTML-fixes.css" type="text/css"><link rel="stylesheet" href="src/custom.css" type="text/css"><meta name="keywords" content="cors, deployment, html, index.html, installation, markdown, offline, viewer"></head><body class="inStandard"><div class="container" id="container"><div class="main" id="main"><div class="header" id="header" role="banner"><h1 id="mtitle">🌐HelpViewer</h1><div id="header-toolbar" class="toolbar" role="toolbar"><a id="printBtn" title="Print page" aria-label="Print page" href="javascript:window.print();">🖨️</a><a id="nav-right" title="Next topic" aria-label="Next topic" href="toc.htm">➡</a><a id="downP-TopicTree" title="Table of Contents" aria-label="Table of Contents" href="toc.htm">📖</a><a id="downP-Glossary" title="Glossary" aria-label="Glossary" href="keywordList/index.htm">📇</a><a id="downP-Fulltext" title="Fulltext search" aria-label="Fulltext search" href="fulltextList/index.htm">🔎</a><a id="downP-Home" title="Home" aria-label="Home" href="index.htm">🏡</a></div></div><div class="content" id="content" role="main" aria-live="polite"><p>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 <strong>index.html</strong> in your browser. MIT licensed.</p><h2 id="h-2-0">How it works<a href="#h-2-0" class="anchor-link"> #</a></h2><ol><li>Try <strong>HelpViewer</strong> on <a href=":viewRepo.htm#" title="👀 View your repository" data-param=":viewRepo.htm">your repository</a>.</li><li>Download the deployment package from <a href="https://github.com/HelpViewer/HelpViewer/releases/download/20260321/package.zip" title="https://github.com/HelpViewer/HelpViewer/releases/download/20260321/package.zip">package.zip</a> and unzip it.</li><li>For correct display, launch the browser without <a href="corsPolicy.htm#h-1-6" title="Browser possibly blocking local file access (file://) due to CORS policy restrictions" data-param="corsPolicy.md">CORS restrictions</a>. Otherwise, you will see a page with message and have to manually select help and data files.<br>Alternatively, if you don't want to interfere with CORS, is to download a local HTTP server for <a href="https://github.com/HelpViewer/MiniHTTPServer/releases/download/20260206/main" title="Local server (Linux)">Linux</a> (static build under Go/musl libc) or <a href="https://github.com/HelpViewer/MiniHTTPServer/releases/download/20260206/main.exe" title="Local server (Windows)">Windows</a>, create a <strong>www</strong> folder in the server location, extract the <strong>HelpViewer</strong> installation into this folder, and start the server on localhost:8080 in your browser.</li><li>Open the <strong>index.html</strong> file in your browser.</li><li>Set the URL parameter <strong>?d=X</strong>, where <strong>X</strong> is the path to your ZIP file or you can define path ending with <strong>/</strong> if you want to read a directory.<br>If you skip this step, <strong>./hlp/Help-{current language}.zip</strong> will be used by default.</li><li>You will see e.g. the <a href="#" title="User quick guide">user documentation</a> directly in HelpViewer, just like you are seeing this web page.</li></ol><h2 id="h-2-1">Used 3rd party products<a href="#h-2-1" class="anchor-link"> #</a></h2><ul><li><a href="http://jszip.org/" title="JSZip JavaScript library - ZIP files manipulation">JSZip library</a> (under MIT)</li><li><a href="https://marked.js.org/" title="Marked JavaScript library - md files to HTML renderer">Marked</a> (under MIT) (optional)</li><li><a href="https://mermaid.js.org/" title="Mermaid library - renderer for diagrams defined by specific textual definitions">Mermaid</a> (under MIT) (optional)</li><li><a href="https://prismjs.com/" title="Prism - syntax highlighting">Prism</a> (under MIT) (optional)</li><li><a href="https://github.com/cure53/DOMPurify" title="DOMPurify - output protection against XSS (Apache License Version 2.0)">DOMPurify</a> (under Apache License Version 2.0) (optional)</li></ul><table><thead><tr><th>Help file</th><th>Version</th></tr></thead><tbody><tr><td>HelpViewer/helpHello</td><td>20260321</td></tr><tr><td>HelpViewer/HelpViewer</td><td>20260321</td></tr><tr><td>Source</td><td>hlp/Help-en.zip</td></tr><tr><td>Date</td><td>2026-03-21 22:51:57</td></tr></tbody></table><p></p></div></div></div></body></html>