hello-astro icon indicating copy to clipboard operation
hello-astro copied to clipboard

Enhancement: Improve Documentation for Diagram Support

Open sidfakenews986 opened this issue 4 months ago • 1 comments

Summary

The current README mentions support for diagram rendering using Mermaid, Markmap, and PlantUML, but there is no detailed documentation on how to implement these features in the blog posts or pages. This lack of guidance can make it challenging for new users to utilize these capabilities effectively.

Suggestion

  1. Add Examples: Provide code snippets demonstrating how to include diagrams in MDX or Markdown pages. This can include simple examples, such as a basic Mermaid flowchart or a Markmap mind map.

  2. Link to Resources: Include links to the official documentation of Mermaid, Markmap, and PlantUML for users who want to explore more advanced features.

  3. Usage Notes: Mention any specific prerequisites or configurations needed before using these features, such as required packages or settings in the project.

By enhancing the documentation in this way, it will empower users to take full advantage of the diagram capabilities in the Hello Astro starter theme, potentially leading to more engaging and informative content on their sites.

sidfakenews986 avatar Oct 04 '25 17:10 sidfakenews986

Hi - there are examples of all three diagram types implemented as sample blog pages in src/content/blog. There are also examples in Markdown and MDX. Can you please review and let me know if anytjhing else needs to be added? Links to the packages are also provided in the About page.

ChristineTham avatar Oct 04 '25 21:10 ChristineTham