|
1 | 1 | # ⚙️Features
|
2 | 2 |
|
3 |
| -- 📦 No installation required - just unzip and run locally |
| 3 | +## 📚 HelpViewer |
| 4 | + |
| 5 | +- 📦 No installation required - just unzip and run locally |
| 6 | +- 🪦 Lightweight - under 1 MiB, 12 files + 2 subfolders (most part of solution compressed) |
| 7 | +- ⚖ MIT licensed |
| 8 | + |
| 9 | +## 🟢 Works out of the box with a single Markdown file ... |
| 10 | + |
4 | 11 | - 💻 Multiplatform - works on all major operating systems via web browsers
|
5 | 12 | - 📴 Ready to work in offline mode without any backend or local server (requires disabling CORS in web browser)
|
6 | 13 | - 🧭 Simple user interface
|
7 | 14 | - 📱 Responsive (desktop and other devices supported)
|
8 |
| -- ↔ Seamless full-screen expansion of topic content |
9 |
| -- 📂 Hierarchical view of topics (collapsible topic tree) |
10 |
| -- 📇 Linking glossary terms to relevant topics and files |
11 |
| -- 🔎 Full-text search dictionary for chapter contents |
12 |
| -- ⏭ Integrated topic navigation buttons |
| 15 | +- 🔲 Seamless full-screen expansion of topic content |
13 | 16 | - 🔖 Bookmarks for chapters supported
|
14 | 17 | - 🎨 Four native color schemes: color (default), greyscale, white on black, and black on white
|
15 | 18 | - ♿ Accessibility rules WCAG 2.1 implemented (accessibilitychecker.org: 89 %, Lighthouse: 96%, [Web Aim][waverep])
|
16 | 19 | - 📄 Print friendly version (prefers greyscale)
|
17 | 20 | - 💬 Tooltips in English, Czech (other languages planned)
|
18 |
| -- 🪦 Lightweight - under 1 MiB, 11 files + 1 subfolder (most part of solution compressed) |
19 |
| -- ⚖ MIT licensed |
20 | 21 |
|
21 |
| -## 🗄️ Deployment to a server is not required, if you choose to do so ... |
| 22 | +## 🚀 When help project is defined ... |
| 23 | + |
| 24 | +- 📂 Hierarchical view of topics (collapsible topic tree) |
| 25 | +- 📇 Linking glossary terms to relevant topics and files |
| 26 | +- 🔎 Full-text search dictionary for chapter contents |
| 27 | +- ⏭ Integrated topic navigation buttons |
| 28 | +- 🌐 Easily switch between different language versions |
| 29 | + |
| 30 | +## 🗄️ Additional features when deployed on a server ... |
22 | 31 |
|
23 |
| -- 🌐 Progressive Web Application (PWA), installable directly to your device for quick access. |
| 32 | +- 🌐 Progressive Web Application (PWA), installable directly to your device for quick access. |
24 | 33 |
|
25 | 34 | [waverep]: https://wave.webaim.org/report#/https://helpviewer.github.io "WAVE WebAim report"
|
0 commit comments