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

Trek syntax highlighting gelijk tussen Markdown en <Canvas> #397

Merged
merged 1 commit into from
Nov 28, 2023

Conversation

hidde
Copy link
Member

@hidde hidde commented Nov 27, 2023

fixes #394

Er zat verschil tussen syntax highlighting in code die:

  • in Markdown code blocks (met ```) was toegevoegd
  • in codevoorbeelden op een <Canvas>

Met deze PR worden die gelijk getrokken, namelijk beide in de kleuren die al in de Canvas zaten (want voldoet aan WCAG). Dit introduceert wel wat ongelukkige herhalingen.

Wat uitleg:

  • de Markdown-rendering van Docusaurus kon ik in de Docusaurusconfig aanpassen (relevante docs), maar dat theme.styles had de styles in een ander formaat nodig dan we reeds in PrismStyle.ts hadden leven.
  • ik heb een lading styles op code / pre + de syntax highlighting related custom properties verhozen van Canvas naar custom.css, zodat ze werken voor alle codeblokken, inclusief die die niet in een Canvas zitten; deze bestaan ook nog in PrismStyle.ts, omdat die anders worden overschreven door andere inline styles
  • aanpassing in PrismStyle.ts is fix: we misten daar -- in de syntax

Ter illustratie,

voor:

codevoorbeeld met afwijkende kleurtjes

na:

codevoorbeeld met canvaskleurtjes

@hidde hidde requested a review from Yolijn November 27, 2023 13:42
Copy link

vercel bot commented Nov 27, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
documentatie ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 27, 2023 1:57pm

@hidde hidde requested a review from rianrietveld November 27, 2023 13:42
@hidde hidde force-pushed the fix-syntax-highlighting branch from a068760 to 2fbdd71 Compare November 27, 2023 13:45
@hidde hidde force-pushed the fix-syntax-highlighting branch from 2fbdd71 to d3793ef Compare November 27, 2023 13:50
@rianrietveld
Copy link
Contributor

rianrietveld commented Nov 27, 2023

@hidde Het zit er goed uit, qua frontend (als je al die inline CSS meuk niet meetelt, want echt... bah).
Ik laat het aan Yolijn om te bekijken of het goed in het systeem past.

Copy link
Contributor

@rianrietveld rianrietveld left a comment

Choose a reason for hiding this comment

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

@hidde LGTM 👍

Copy link
Member

@Yolijn Yolijn left a comment

Choose a reason for hiding this comment

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

Hmm goed dat de pre er nu hetzelfde uit ziet, maar jammer dat daarvoor alles nu in custom.css moet staan. Ik hoop dat we binnenkort tijd hebben om de boel eens even goed in elkaar te draaien, maar voor nu ok

@hidde
Copy link
Member Author

hidde commented Nov 28, 2023

Had de overweging gemaakt tussen iets viezere custom.css of (arguably) iets viezere Markdownbestanden (bv als styles netjes aan een component hangen maar dan wel dat component z'n weg naar alle pre's moet vinden), dit leek me zo het mooiste (maar misschien zie ik een derde oplossing over het hoofd).

@hidde hidde merged commit f20656d into main Nov 28, 2023
6 checks passed
@hidde hidde deleted the fix-syntax-highlighting branch November 28, 2023 07:41
hidde added a commit that referenced this pull request Nov 30, 2023
* docs: add descriptions

* docs: lint-fix:prettier

* Add footer info

* typo

* Add FormFooterInfo

* fix: remove comment

* Update _description-target-size.md

Visual toegevoegd met begeleidende tekst.

* fix: Make syntax highlighting same for MD code blocks and code in a Canvas (#397)

* Maak richtlijnen meer zoals Jeffrey's ontwerp (#398)

* fix: Align dos and donts better with intended visual design

* docs: Make dos and donts uppercase to work better in fixed design

* fix: button style on focus

---------

Co-authored-by: Yolijn <[email protected]>

* fix: Capitalise title to work in new layout

* fix: Tweak vertical spacing

* fix: Lint

* docs: remove double ids

---------

Co-authored-by: Hidde de Vries <[email protected]>
Co-authored-by: Jeffrey Lauwers <[email protected]>
Co-authored-by: Yolijn <[email protected]>
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.

Kleuren code-blokken html hetzelfde maken als kleuren code-blokken guideline
3 participants