Commit bf05d08
Enhance web documentation design, download section, and markdown-based docs (#33)
* Initial plan
* Enhance web documentation with GLFW-style design and download section
Co-authored-by: LeeGoDamn <243561453+LeeGoDamn@users.noreply.github.com>
* Fix code review issues: XSS prevention, error handling, event parameter
Co-authored-by: LeeGoDamn <243561453+LeeGoDamn@users.noreply.github.com>
* Address additional code review feedback: remove unused variable, fix deprecated API
Co-authored-by: LeeGoDamn <243561453+LeeGoDamn@users.noreply.github.com>
* Fix language switching and convert docs to markdown-based rendering
Co-authored-by: LeeGoDamn <243561453+LeeGoDamn@users.noreply.github.com>
* Improve security and performance of markdown documentation loading
Co-authored-by: LeeGoDamn <243561453+LeeGoDamn@users.noreply.github.com>
* Add DOMPurify for XSS protection in markdown rendering
Co-authored-by: LeeGoDamn <243561453+LeeGoDamn@users.noreply.github.com>
* docs: reorganize README layout following best practices
- Move official website link to description section with blockquote
- Keep badge row for project status only (CI, license, language, platform)
- Remove workflow badges from website (docs/index.html)
- Follow GLFW/SDL/OpenCV layout best practices
* Enhance documentation with syntax highlighting and improved styling
- Add Highlight.js (vs2015 theme) for syntax highlighting
- Replace hardcoded HTML spans with library-based highlighting
- Add language modules: cpp, c, bash, shell, cmake
- Update documentation page styling
- Set overall background to #E8E8E8 (light grey)
- Set code blocks to #1E1E1E (dark grey, VSCode style)
- Set sidebar to #F5F5F5
- Remove CSS color inheritance that was blocking syntax colors
- Improve Installation section display
- Change to fixed 2-column layout for better readability
- Increase card padding and font sizes
- Optimize to prevent horizontal scrolling
- Fix language tags
- Change 'cmd' to 'shell' in markdown files
- Add shell language module to support Windows commands
* fix: improve documentation page and API robustness
Fixes identified in PR code review:
**docs/js/main.js:**
- Improve platform asset classification using regex word boundaries instead of
indexOf() to avoid substring conflicts (e.g., 'darwin-linux' misclassification)
- Add cache expiration mechanism (1 hour) for GitHub API responses to show
latest release information
- Enhance URL validation to restrict to HTTPS and authorized GitHub domains
(github.com, github.io, githubusercontent.com)
**docs/documentation.html:**
- Fix footer documentation links to point to correct GitHub file locations
instead of non-existent local markdown files
- Add ARIA labels (role='navigation', aria-label) for better accessibility
- Implement slugify() function to generate stable heading IDs from text
(e.g., 'C++ API Reference' -> 'cpp-api-reference') for durable anchor links
- Improve error messages with context-specific feedback (network vs file not found)
- Fix missing closing brace in generateSidebar() function
- Optimize sidebar navigation to make all headings clickable without duplication
**README.md:**
- Restore 'Dual Language APIs' feature description (was commented out)
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: LeeGoDamn <243561453+LeeGoDamn@users.noreply.github.com>
Co-authored-by: wangyang (wysaid) <wysaid@gmail.com>1 parent e198969 commit bf05d08
8 files changed
Lines changed: 2172 additions & 570 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
| 15 | + | |
| 16 | + | |
15 | 17 | | |
16 | 18 | | |
17 | 19 | | |
| |||
29 | 31 | | |
30 | 32 | | |
31 | 33 | | |
32 | | - | |
| 34 | + | |
33 | 35 | | |
34 | 36 | | |
35 | 37 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
| 15 | + | |
| 16 | + | |
15 | 17 | | |
16 | 18 | | |
17 | 19 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
0 commit comments