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

Adjust some heading styles and code blocks higlighting #4822

Closed
wants to merge 2 commits into from

Conversation

100gle
Copy link
Contributor

@100gle 100gle commented Sep 27, 2023

What kind of changes does this PR include?

  • New or updated content
  • Something else!

Description

I adjust some heading styles and code block highlighting in guides/integrations-guide/cloudflare.mdx to make it be more readable.

Related Issue / Implementation PR

  • Closes Issue #

@netlify
Copy link

netlify bot commented Sep 27, 2023

Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit e810033
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/65139805b3a9cc00076c503f
😎 Deploy Preview https://deploy-preview-4822--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.

@100gle 100gle changed the title Adjust some heading styles and code blocks highlighting Adjust some heading styles and code blocks higlighting Sep 27, 2023
@Genteure
Copy link
Contributor

Genteure commented Sep 27, 2023

The file src/content/docs/en/guides/integrations-guide/cloudflare.mdx is pulled from the package README by a script running on GitHub Actions, as indicated at the start of the file:

# NOTE: This file is auto-generated from 'scripts/generate-integration-pages.ts'
#       and pulls content directly from the package’s README.
#       DO NOT MAKE EDITS TO THIS FILE DIRECTLY, THEY WILL BE OVERWRITTEN!
#       For corrections, please edit the package README at
#       https://github.com/withastro/astro/tree/main/packages/integrations/cloudflare/

Please close this PR and reopen another in https://github.com/withastro/astro

Another thing to consider is GitHub and npmjs.com (@astrojs/cloudflare) does not support expressive code. If the primary goal is highlight the differences then ```diff would be better because ```js ins={8} would get rendered like ```js. It's a tradeoff of UX between npmjs and astro doc site.

The @astrojs/cloudflare README already contains an "expressive code" code block.

@Genteure
Copy link
Contributor

After looking further into this, this PR would be a (partial) duplicate of withastro/astro#8654 as that PR also contains most of the changes made in this PR and more.

@100gle 100gle closed this Sep 27, 2023
@alexanderniebuhr
Copy link
Member

@100gle I've just added you as a co-author, to withastro/astro#8654. So you still have the contribution!

@100gle 100gle deleted the adjust-code-block branch October 4, 2023 12:24
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.

3 participants