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.

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

docs: fix mdc component usage and cloudflare preset reference #2600

Merged
merged 4 commits into from
Aug 1, 2024

Conversation

adamdehaven
Copy link
Member

@adamdehaven adamdehaven commented Jul 8, 2024

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme, or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

  • Fixes incorrect MDC syntax was preventing the following paragraph from displaying.
  • Fixes Nitro preset name (cloudflare => cloudflare_module)
  • Fixes formatting on the Cloudflare page (see below).

Note

It appears that undocs (or something in the docs site config) is not properly transforming ordered lists defined in markdown, so I just switched to a bulleted list. Probably needs to be addressed at the source.


Formatting before

formatting before

Formatting after

formatting after

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@adamdehaven adamdehaven mentioned this pull request Jul 8, 2024
8 tasks
@adamdehaven adamdehaven changed the title docs: fix mdc component usage docs: fix mdc component usage and cloudflare preset reference Jul 9, 2024
@adamdehaven
Copy link
Member Author

@pi0 uodated from the proper branch

Copy link
Member

@pi0 pi0 left a comment

Choose a reason for hiding this comment

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

Thank you!

@pi0 pi0 merged commit 6f1fa4b into nitrojs:v2 Aug 1, 2024
4 checks passed
@pi0 pi0 mentioned this pull request Oct 31, 2024
@adamdehaven adamdehaven deleted the docs/fix-mdc-syntax branch November 2, 2024 02:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants