-
Notifications
You must be signed in to change notification settings - Fork 905
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update GenerateDocs.ps1 to support the Astro Framework #3446
Labels
Comments
This was referenced May 17, 2024
2 tasks
This was referenced May 17, 2024
st3phhays
added a commit
to st3phhays/choco
that referenced
this issue
May 20, 2024
The GenerateDocs.ps1 file has been modified to support the Astro framework that docs.chocolatey.org will be using. - 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`
10 tasks
st3phhays
added a commit
to st3phhays/choco
that referenced
this issue
May 20, 2024
The GenerateDocs.ps1 file has been modified to support the Astro framework that docs.chocolatey.org will be using. - 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`
st3phhays
added a commit
to st3phhays/choco
that referenced
this issue
May 20, 2024
The GenerateDocs.ps1 file has been modified to support the Astro framework that docs.chocolatey.org will be using. - 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`
st3phhays
added a commit
to st3phhays/choco
that referenced
this issue
Jun 4, 2024
The GenerateDocs.ps1 file has been modified to support the Astro framework that docs.chocolatey.org will be using. - 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`
st3phhays
added a commit
to st3phhays/choco
that referenced
this issue
Jun 7, 2024
The GenerateDocs.ps1 file has been modified to support the Astro framework that docs.chocolatey.org will be using. - 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`
gep13
pushed a commit
to st3phhays/choco
that referenced
this issue
Jun 12, 2024
The GenerateDocs.ps1 file has been modified to support the Astro framework that docs.chocolatey.org will be using. - 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`
gep13
added a commit
that referenced
this issue
Jun 12, 2024
(#3446) (ENGTASKS-3631) Update GenerateDocs.ps1
josh-cooley
added a commit
to josh-cooley/choco
that referenced
this issue
Jul 8, 2024
…evelop * 'develop' of https://github.com/josh-cooley/choco: (145 commits) (maint) Add CODEOWNERS files (build) Add templated notifications to all builds (build) Add verification of source scripts (doc) Further tweak docgen for Chocolatey.PowerShell (doc) Tweak docgen for Chocolatey.PowerShell (chocolatey#3446) Update GenerateDocs.ps1 (chocolatey#3307) Do not create Tools directory from MSI (maint) Do not create Chocolatey directory in MSI (chocolatey#310) Fix path to chocolatey.lib files (maint) Corrected casing of file (chocolatey#23) Move call to SetRemotePackageNamesIfAllSpecified (chocolatey#1901) Revert commit to display location (maint) Update Authenticode Signature (tests) Some minor tweaks for test consistency (chocolatey#310) Set-EnvironmentVariable: delete values properly (tests) Remove v2 import tests (chocolatey#310) Fix test issues (chocolatey#310) Fixup v2 compatibility (tests) Working on tests during pairing session (chocolatey#2050) Add Pester test for --ignore-pinned option ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Checklist
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:
{/* stuff */}
instead of<!-- stuff -->
.mdx
Additional Context
No response
Related Issues
The text was updated successfully, but these errors were encountered: