Skip to content

Conversation

@AlexHedley
Copy link
Contributor

See #29

@AlexHedley
Copy link
Contributor Author

@KubaO not sure where you comment has gone, do you "Review changes" or are you going directly to the file?
Usually they'd show up here.
Anywho I've commented out mermaid config.

back_to_top: true
back_to_top_text: "Back to top"

footer_content: 'Copyright © 2025 TWINBASIC LTD (Company No. 16590181, VAT No. GB497509439)'
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's too broad. Some pages need more copyright statements, since they draw from e.g. VBA documentation. It requires some thought.

docs/_config.yml Outdated
enable_copy_code_button: true

# By default, consuming the theme as a gem leaves mermaid disabled; it is opt-in
mermaid:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd not be adding mermaid until there are some mermaid diagrams actually in the docs :)

Another thing: does mermaid do offline rendering? We'd definitely want pre-rendered SVGs, no javascript at runtime. Same would go for mathjax - it is runtime by default, should be offline pre-rendered.

That's to keep the loading times good even on slow collections. That's a good benefit of a site built almost from scratch - there's very little overhead.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could use the https://github.com/mermaid-js/mermaid-cli to output a static file and display that?

@KubaO KubaO merged commit d0acaf7 into twinbasic:main Jan 13, 2026
@AlexHedley AlexHedley mentioned this pull request Jan 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants