dosubot[bot] commented on issue #408: URL: https://github.com/apache/incubator-hugegraph-doc/issues/408#issuecomment-2984839688
<!-- Greeting --> Hi @weijinglin! I'm [Dosu](https://go.dosu.dev/dosubot) and Iām helping the incubator-hugegraph-doc team. <!-- Answer --> To enable Mermaid diagram rendering in the HugeGraph documentation, add the following to your `config.toml`: ```toml [params.mermaid] enable = true [markup] [markup.highlight] guessSyntax = false ``` This activates the built-in Docsy/Hugo support for Mermaid diagrams, so code blocks with `mermaid` will render as diagrams instead of raw text. The site already includes the necessary scripts and logic to load and initialize Mermaid.js when this config is present [source](https://github.com/apache/incubator-hugegraph-doc/blob/48ff6f261c634e8d8ae9c4fac9e21524f67424b5/themes/docsy/layouts/partials/scripts.html). For image issues: make sure all images referenced in documentation are stored locally (for example, in the `static/` directory) rather than using remote URLs, which can break or be blocked [source](https://github.com/apache/incubator-hugegraph-doc/blob/48ff6f261c634e8d8ae9c4fac9e21524f67424b5/config.toml). Hosting all third-party resources (like Mermaid.js, images, fonts) locally also helps avoid CSP and privacy policy issues [source](https://github.com/apache/incubator-hugegraph-doc/issues/388). After updating the configuration and image locations, rebuild the site and the diagrams/images should render as expected. <!-- Dosu Comment Footer --> *To reply, just mention [@dosu](https://go.dosu.dev/dosubot).* --- <sup>How did I do? [Good](https://app.dosu.dev/response-feedback/8e5c609e-d8f0-4407-b7a7-f4f2706dcc53?feedback_type=great_response) | [Irrelevant](https://app.dosu.dev/response-feedback/8e5c609e-d8f0-4407-b7a7-f4f2706dcc53?feedback_type=irrelevant_answer) | [Incorrect](https://app.dosu.dev/response-feedback/8e5c609e-d8f0-4407-b7a7-f4f2706dcc53?feedback_type=incorrect_sources) | [Verbose](https://app.dosu.dev/response-feedback/8e5c609e-d8f0-4407-b7a7-f4f2706dcc53?feedback_type=too_verbose) | [Hallucination](https://app.dosu.dev/response-feedback/8e5c609e-d8f0-4407-b7a7-f4f2706dcc53?feedback_type=hallucination) | [Report š](https://app.dosu.dev/response-feedback/8e5c609e-d8f0-4407-b7a7-f4f2706dcc53?feedback_type=bug_report) | [Other](https://app.dosu.dev/response-feedback/8e5c609e-d8f0-4407-b7a7-f4f2706dcc53?feedback_type=other)</sup> [](https://go.dosu.dev/discord-bot) [! [Share on X](https://img.shields.io/badge/X-share-black)](https://twitter.com/intent/tweet?text=%40dosu_ai%20helped%20me%20solve%20this%20issue!&url=https%3A//github.com/apache/incubator-hugegraph-doc/issues/408) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
