Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Refactor Configuration Reference docgen script #5341

Merged
merged 2 commits into from
Nov 10, 2023
Merged

Refactor Configuration Reference docgen script #5341

merged 2 commits into from
Nov 10, 2023

Conversation

delucis
Copy link
Member

@delucis delucis commented Nov 10, 2023

Description (required)

  • Updates our configuration reference generation script to add support for @kind h4 (and other heading levels) in addition to our existing @kind heading support.
  • Accompanies [docs] test config-reference formatting for sidebar astro#9052 and already includes a preview of what those updates would look like with this new version of the script.
  • Also refactored this script a bunch because it was kind of gnarly how some of that was written.

@delucis
Refactor Configuration Reference docgen script
287b7b6 
Adds support for `@kind h4` (and other heading levels) in addition to our existing `@kind heading` support.
@delucis
Update reference page based on withastro/astro#9052
7aaeaed
@delucis delucis added the ci Automated PRs created by CI, or PRs about automation - ask @delucis for help! label Nov 10, 2023
@netlify Netlify
Copy link

netlify bot commented Nov 10, 2023 •
edited
Loading

✅ Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit 7aaeaed
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/654e7a7f8c1f350008ddb819
😎 Deploy Preview https://deploy-preview-5341--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

sarah11918
sarah11918 approved these changes Nov 10, 2023
View reviewed changes
Copy link
Member

@sarah11918 sarah11918 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Preview looks great! Thanks Chris!

@delucis delucis merged commit 2a54003 into main Nov 10, 2023
@delucis delucis deleted the chris/docgen branch November 10, 2023 19:04
100gle added a commit to 100gle/docs that referenced this pull request Nov 11, 2023
@100gle
update withastro#5341
c193fb1
yanthomasdev added a commit that referenced this pull request Nov 12, 2023
@100gle @yanthomasdev
i18n(zh-cn): update reference/configuration-reference.mdx (#5349)
de6797b 
* i18n(zh-cn): update `reference/configuration-reference.mdx`

* update #5331

* update #5332

* update #5341

* Add internationalization guide to nav menu.

* Fix link

---------

Co-authored-by: Yan Thomas <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sarah11918 sarah11918 sarah11918 approved these changes

Assignees
No one assigned
Labels
ci Automated PRs created by CI, or PRs about automation - ask @delucis for help!
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@delucis @sarah11918