Skip to content

Commit

Permalink
docs(a11y): update syntax highlighting theme to fix contrast issues (#…
Browse files Browse the repository at this point in the history
…3341)

This PR changes the syntax highlighting theme we use in the docs. The
reason for the change is that the previous theme we used didn't have
sufficient color contrast between its comment strings and its
background.

## Options

I decided to use the Oceanic Next color theme that is included with
docusaurus. Looking through, the only other dark theme that also passed
AA contrast checks was VS Dark. The reason I picked Oceanic over VS Dark
is simply that I like it better.

For demonstration, here's what the Oceanic theme looks like:

![image](https://user-images.githubusercontent.com/17786332/225867069-f0d9c721-8927-4e70-984e-b9160992811b.png)

And here's the VS Dark theme:

![image](https://user-images.githubusercontent.com/17786332/225867089-6dac9cb2-6ebb-4b9e-ae5c-3be9956cbf60.png)


## Bonus change

The PR also includes a fix to render a pricing admonition correctly.
It's not related to the PR, but I noticed it rendered incorrectly while
I was working on it.
  • Loading branch information
thomasheartman committed Mar 17, 2023
1 parent d23266d commit 335374a
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
2 changes: 1 addition & 1 deletion website/docs/tutorials/quickstart.md
Expand Up @@ -110,7 +110,7 @@ Now you can fetch the feature toggle you created and try turning it on / off in

If you want to set up your own instance for testing purposes you can easily do so by using one of our premade setup kits for Heroku or DigitalOcean.

::: info Pricing
:::info Pricing

Both DigitalOcean and Heroku will charge you for running Unleash on their services. However, if you use the DigitalOcean link below and are a new user, you will receive $100 in free credits.

Expand Down
1 change: 1 addition & 0 deletions website/docusaurus.config.js
Expand Up @@ -88,6 +88,7 @@ module.exports = {
],
},
prism: {
theme: require('prism-react-renderer/themes/oceanicNext'),
additionalLanguages: [
'csharp',
'dart',
Expand Down

0 comments on commit 335374a

Please sign in to comment.