The site shows the same pages as the Markdown files, with more ways to move around. It needs no server, so you can open it from a folder or put it on any static host.
The site is static files, so any static host can serve it. See Publish the site.
How it works
src/site.js buildSite writes one page for each node, virtual node, and tree top. It also writes a Tasks page, a Glossary page, and a search index. Every link is relative.
It renders Markdown with marked. Links to nodes go to their pages. Links to other files go to site.sourceUrl, if it is set.
site-assets/ holds the stylesheet and the browser script. The script makes boxes in Mermaid diagrams into links, and runs the search and the sidebar tabs.
Mermaid runs in the browser, with securityLevel: 'strict'. By default, pages load Mermaid from a CDN. With "site": { "mermaid": "local" } in the configuration, buildSite copies the project's own single-file build (mermaid.min.js, about 2.5 MB) into the site, so diagrams work offline. idk-plans does not depend on Mermaid, so the project must install it.
Tasks
- Make diagram boxes into links
- Show a sidebar for each tree, and search
- List open tasks, and a glossary
- Use the project's own Mermaid, so diagrams work offline
- Check the layout on a phone
- Give the site a theme with more character: type, color, and spacing. The current style is plain.