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: add languages to code highlighting #5576

Merged

Conversation

hsheth2
Copy link
Collaborator

@hsheth2 hsheth2 commented Aug 4, 2022

I picked these syntax themes because they looked good, but am not particularly attached to them - we can definitely change it around. Specifically, the vscode light theme's background color feels a bit too light. Docusaurus uses some custom themes that I think look pretty good - maybe we can use those?

Adds a couple new langs to docusaurus highlighting.

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

I picked these syntax themes because they looked good, but am not
particularly attached to them - we can definitely change it around.
@hsheth2 hsheth2 marked this pull request as draft August 4, 2022 22:14
@github-actions
Copy link

github-actions bot commented Aug 4, 2022

Unit Test Results (build & test)

622 tests  +1   618 ✔️ +1   15m 33s ⏱️ -10s
158 suites +1       4 💤 ±0 
158 files   +1       0 ±0 

Results for commit 7ea8042. ± Comparison against base commit e5a823e.

♻️ This comment has been updated with latest results.

@anshbansal anshbansal added the docs Issues and Improvements to docs label Aug 9, 2022
@maggiehays
Copy link
Collaborator

the vscode light theme's background color feels a bit too light. Docusaurus uses some custom themes that I think look pretty good - maybe we can use those?

+1 - it's way too light & tough to read. Let's try Docusaurus's theme!

@hsheth2 hsheth2 marked this pull request as ready for review December 5, 2022 22:45
@hsheth2
Copy link
Collaborator Author

hsheth2 commented Dec 5, 2022

@maggiehays decided against changing the themes right now - main issue was (and still is) missing syntax highlighting for certain keywords

@hsheth2 hsheth2 changed the title docs: make code highlighting look better docs: add languages to code highlighting Dec 6, 2022
@jjoyce0510 jjoyce0510 merged commit e37157f into datahub-project:master Dec 7, 2022
@hsheth2 hsheth2 deleted the docs-website-highlighting branch December 7, 2022 18:58
cccs-Dustin pushed a commit to CybercentreCanada/datahub that referenced this pull request Feb 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues and Improvements to docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants