Skip to content

Commit 4147ef8

Browse files
VitSimonVitSimon
committed
20260216-1
1 parent 1a7bb4f commit 4147ef8

33 files changed

Lines changed: 61 additions & 161 deletions

‎README.htm‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
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/overridePlusMinusVars.css" type="text/css"><link rel="stylesheet" href="src/admonitions.css.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#_viewRepo-h1" 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/__VERSION__/package.zip" title="https://github.com/HelpViewer/HelpViewer/releases/download/__VERSION__/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="?d=hlp-user/Help-__.zip" 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>20260216</td></tr><tr><td>HelpViewer/HelpViewer</td><td>20260209</td></tr><tr><td>Source</td><td>hlp/Help-en.zip</td></tr><tr><td>Date</td><td>2026-02-16 12:30:31</td></tr></tbody></table><p></p></div></div></div></body></html>
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/overridePlusMinusVars.css" type="text/css"><link rel="stylesheet" href="src/admonitions.css.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/20260216-1/package.zip" title="https://github.com/HelpViewer/HelpViewer/releases/download/20260216-1/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>20260216-1</td></tr><tr><td>HelpViewer/HelpViewer</td><td>20260216-1</td></tr><tr><td>Source</td><td>hlp/Help-en.zip</td></tr><tr><td>Date</td><td>2026-02-16 14:01:36</td></tr></tbody></table><p></p></div></div></div></body></html>

‎_viewRepo.htm‎

Lines changed: 1 addition & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1 @@
1-
<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1"><title></title><meta name="description" content="This guide helps you see your own repository inside HelpViewer. It's not a migration - some features are limited or might not work just yet. But it might just b"><link rel="icon" type="image/png" href="favicon.png"><meta property="og:title" content=""><meta property="og:description" content="This guide helps you see your own repository inside HelpViewer. It's not a migration - some features are limited or might not work just yet. But it might just b"><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/overridePlusMinusVars.css" type="text/css"><link rel="stylesheet" href="src/admonitions.css.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"></head><body class="inStandard"><div class="container" id="container"><div class="main" id="main"><div class="header" id="header" role="banner"><h1 id="mtitle"></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-left" title="Previous topic" aria-label="Previous topic" href="docker.htm">⬅</a><a id="nav-right" title="Next topic" aria-label="Next topic" href="corsPolicy.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 id="_viewRepo-par1">This guide helps you see your own repository inside HelpViewer. It's not a migration - some features are limited or might not work just yet. But it might just be the first step toward choosing a tool that fits you. Just enter some information below and click the generated link to get started.</p><p id="_viewRepo-par2">🛈 This preview uses public content from GitHub.<br>If your repository is private, the preview will not work.<br>Everything runs in your browser only.</p><p>&nbsp;</p><div id="form"><div class="form-row"><label for="_viewRepo-org" id="_viewRepo-org-label">Organization/User</label><input type="text" id="_viewRepo-org"></div><div class="form-row"><label for="_viewRepo-repo" id="_viewRepo-repo-label">Repository</label><input type="text" id="_viewRepo-repo"></div><div class="form-row"><label for="_viewRepo-branch" id="_viewRepo-branch-label">Branch/Tag</label><input type="text" id="_viewRepo-branch" value="master"></div><div class="form-row"><label for="_viewRepo-langs" id="_viewRepo-langs-label">Language&nbsp;subdirectories</label><input type="checkbox" id="_viewRepo-langs"></div><div class="form-row"><label for="_viewRepo-zip" id="_viewRepo-zip-label">Browse ZIP release</label><input type="checkbox" id="_viewRepo-zip"></div></div><div class="form-row"><label id="_viewRepo-link">Link</label><span id="previewLink"></span></div><script>
2-
function _init() {
3-
const valH1 = '_viewRepo-h1';
4-
const translateThis = [valH1, '_viewRepo-par1', '_viewRepo-par2', '_viewRepo-link'];
5-
6-
translateThis.forEach(id => {
7-
var idField = id;
8-
if (id === valH1) idField = 'mtitle';
9-
var el = $(idField);
10-
if (el) el.innerHTML = _T(id);
11-
});
12-
13-
const fieldOrg = '_viewRepo-org';
14-
const fieldRepo = '_viewRepo-repo';
15-
const fieldBranch = '_viewRepo-branch';
16-
const fieldLanguages = '_viewRepo-langs';
17-
const fieldZIP = '_viewRepo-zip';
18-
19-
const formO = $('form');
20-
21-
appendField(formO, fieldOrg, '');
22-
appendField(formO, fieldRepo, '');
23-
appendField(formO, fieldBranch, 'master');
24-
appendField(formO, fieldLanguages, '', FormFieldType.CHECKBOX);
25-
appendField(formO, fieldZIP, '', FormFieldType.CHECKBOX);
26-
27-
const iorg = $(fieldOrg);
28-
const irepo = $(fieldRepo);
29-
const ibranch = $(fieldBranch);
30-
const ilangs = $(fieldLanguages);
31-
const izip = $(fieldZIP);
32-
33-
const onBlur = updateLink;
34-
const eventName = 'change';
35-
36-
iorg.addEventListener(eventName, onBlur);
37-
irepo.addEventListener(eventName, onBlur);
38-
ibranch.addEventListener(eventName, onBlur);
39-
ilangs.addEventListener(eventName, onBlur);
40-
izip.addEventListener(eventName, (event) => {
41-
const sender = event.target;
42-
if (!sender.value || sender.checked === false) return;
43-
ibranch.value = getDateInYYYYMMDD(new Date())
44-
});
45-
izip.addEventListener(eventName, onBlur);
46-
47-
function updateLink() {
48-
const org = iorg.value.trim();
49-
const repo = irepo.value.trim();
50-
const branch = ibranch.value.trim();
51-
const langs = ilangs.checked;
52-
const zip = izip.checked;
53-
54-
const span = $("previewLink");
55-
56-
if (org && repo) {
57-
var url = (zip && zip !== 'off')
58-
? getHelpRepoUriReleaseZip(org, repo, branch)
59-
: getHelpRepoUri(org, repo, langs, branch);
60-
url = `?d=${url}`;
61-
span.innerHTML = `<a href="${url}" target="_blank" rel="noopener noreferrer">${url}</a>`;
62-
} else {
63-
span.textContent = "";
64-
}
65-
}
66-
}
67-
_init();
68-
</script><p></p></div></div></div></body></html>
1+
<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1"><title></title><meta name="description" content=""><link rel="icon" type="image/png" href="favicon.png"><meta property="og:title" content=""><meta property="og:description" content=""><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/overridePlusMinusVars.css" type="text/css"><link rel="stylesheet" href="src/admonitions.css.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"></head><body class="inStandard"><div class="container" id="container"><div class="main" id="main"><div class="header" id="header" role="banner"><h1 id="mtitle"></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-left" title="Previous topic" aria-label="Previous topic" href="docker.htm">⬅</a><a id="nav-right" title="Next topic" aria-label="Next topic" href="corsPolicy.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 id="_viewRepo-par1"></p><p id="_viewRepo-par2"></p><p>&nbsp;</p><div id="form"></div><div class="form-row"><label id="_viewRepo-link"></label><span id="previewLink"></span></div><p></p></div></div></div></body></html>

0 commit comments

Comments
 (0)