chocolatey/choco

Update GenerateDocs.ps1 to support the Astro Framework

st3phhays opened this issue · 0 comments

Checklist

  • I have verified this is the correct repository for opening this issue.
  • I have verified no other issues exist related to my request.

Is Your Feature Request Related To A Problem? Please describe.

We are utilizing the Astro framework on docs.chocolatey.org, and there are some things that will need to be updated on the generated .md files in order for Astro to compile.

Describe The Solution. Why is it needed?

The GenerateDocs.ps1 file should:

  • Frontmatter keys are lowercase
  • import the Xref Component
  • Switch links to use the Xref Component
  • Ensure all code is within code blocks and not 4 spaces (.mdx does not recognize code blocks as 4 spaces)
  • Ensure NOTE and WARNINGS are formatted correctly
  • Update comments to use {/* stuff */} instead of <!-- stuff -->
  • Change file format to .mdx

Additional Context

No response

Related Issues