Skip to content

Docs/diff highlight#204

Merged
beeme1mr merged 2 commits intoopen-feature:mainfrom
luizgribeiro:docs/diffHighlight
Aug 15, 2023
Merged

Docs/diff highlight#204
beeme1mr merged 2 commits intoopen-feature:mainfrom
luizgribeiro:docs/diffHighlight

Conversation

@luizgribeiro
Copy link
Copy Markdown
Contributor

@luizgribeiro luizgribeiro commented Aug 15, 2023

This PR

  • Adds Custom Magic Comments to provide diff highlights
  • Adds diff and syntax highlight for the Node.js getting started guide

Related Issues

N/A

Notes

While following the getting started guide I got a bit uncomfortable with all the "-" and "+" used for the diffs and lack of syntax highlight. I had a good experience recently with backstage.io and decided to port the current code blocks to a format that is similar to theirs.

Follow-up Tasks

  • Porting the rest of the getting started guides with the diffs highlights (if it gets accepted)

How to test

It can be run locally, but before and after images are provided bellow.

Before

image

After

image

Signed-off-by: Luiz Ribeiro <ltrindaderibeiro@gmail.com>
Signed-off-by: Luiz Ribeiro <ltrindaderibeiro@gmail.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented Aug 15, 2023

Deploy Preview for openfeature ready!

Name Link
🔨 Latest commit 6a0f042
🔍 Latest deploy log https://app.netlify.com/sites/openfeature/deploys/64dac1de8a28970008440576
😎 Deploy Preview https://deploy-preview-204--openfeature.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.

@beeme1mr
Copy link
Copy Markdown
Member

Thanks, I'll review this tomorrow.

@beeme1mr
Copy link
Copy Markdown
Member

Thanks @luizgribeiro, that's a massive improvement 😄

@beeme1mr beeme1mr merged commit 4525e57 into open-feature:main Aug 15, 2023
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