Commit fe0cbb3
committed
fix(docs): make API docs browseable on GitHub Pages
Two problems prevented /viktorani/api/ from being browseable:
1. Service worker navigation fallback intercepted all requests under
/viktorani/ and served index.html instead of the TypeDoc files.
Fix: add navigateFallbackDenylist: [/^\/viktorani\/api\//] to the
Workbox config in vite.config.ts so the SW passes those requests
through to the static files on gh-pages.
2. typedoc-plugin-markdown produced .md files that browsers cannot
render natively. Fix: remove the plugin so TypeDoc generates its
default HTML output — self-contained with sidebar nav and search.
Also removes typedoc-plugin-markdown from devDependencies in package.json.1 parent d11ee30 commit fe0cbb3
3 files changed
Lines changed: 4 additions & 6 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
61 | 61 | | |
62 | 62 | | |
63 | 63 | | |
64 | | - | |
65 | 64 | | |
66 | 65 | | |
67 | 66 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
18 | | - | |
19 | | - | |
20 | | - | |
| 18 | + | |
21 | 19 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
31 | 34 | | |
32 | 35 | | |
33 | 36 | | |
| |||
44 | 47 | | |
45 | 48 | | |
46 | 49 | | |
47 | | - | |
48 | | - | |
49 | 50 | | |
50 | 51 | | |
51 | 52 | | |
| |||
0 commit comments