feat: build toc and dashboard in hugo

[olizilla]

Avoid building the ToC and the dashboard on the client side by parse data from dom and building the toc from data.

Generates a toc.json file in the hugo data dir, which is then used by the toc partial and the dashboard-spec shortcode.

example toc.json

[
  {
    "id": "intro",
    "number": "1",
    "tagName": "H1",
    "text": "Introduction",
    "page": true,
    "dashboardWeight": "0.2",
    "dashboardAudit": "n/a",
    "dashboardAuditURL": "",
    "dashboardAuditDate": "",
    "dashboardState": "reliable",
    "children": [
      {
        "id": "intro__spec-status",
        "number": "1.1",
        "tagName": "H2",
        "text": "Spec Status",
        "page": false,
        "dashboardWeight": "0.2",
        "dashboardAudit": "n/a",
        "dashboardAuditURL": "",
        "dashboardAuditDate": "",
        "dashboardState": "reliable",
        "children": [

TODO

• ensure livereload picks up edits.
• add watch mode for dom parser
• tidy up
• build dashboard from data

fixes #1125

License: MIT
Signed-off-by: Oli Evans [email protected]

[olizilla]

@hugomrdias local testing shows we can have hugo render to disk in dev mode, parse the generated dom, write the toc model as JSON to the hugo data dir, and have hugo pick up the change, and rebuild the ToC 🎉

Next up i'm going to move the spec dashboard back to hugo but this time built from the toc model.

Would be great to get your eyes on it in the mean time to double check this is not too outrageous.

[hugomrdias]

LGTM can you make it work with the diagrams watcher ? we should use only one watcher.
maybe rename diagrams.js to pipelines and pack everything into a single watcher.

[hugomrdias]

hidden toc sections are only actually hidden at runtime with js, can we build the toc already hidden at build time ?

[olizilla]

hidden toc sections are only actually hidden at runtime with js, can we build the toc already hidden at build time ?

Done!

GTM can you make it work with the diagrams watcher ? we should use only one watcher. maybe rename diagrams.js to pipelines and pack everything into a single watcher.

Will do in separate PR

[hugomrdias]

the build is not minifying the output html

[olizilla]

@hugomrdias the npm run script build is minifying the html output with the --minify flag to hugo, there is no change there. I've compared the output and the only diffs are the inclusion of the ToC & Dashboard, and the cache busting values on all images.

The dev build probably doesn't minify the output, but I dont see a problem there.

[hugomrdias]

I know but some the preview url doesnt load the minified html