Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Code Issues Projects Releases Wiki Activity
335374aa6d
unleash.unleash/website
History
Thomas Heartman 335374aa6d
docs(a11y): update syntax highlighting theme to fix contrast issues (#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.
2023-03-17 12:19:13 +02:00
..
.storybook
docs docs(a11y): update syntax highlighting theme to fix contrast issues (#3341) 2023-03-17 12:19:13 +02:00
remote-content Source proxy and Edge docs from GitHub (#3122) 2023-02-16 13:36:28 +01:00
src Source proxy and Edge docs from GitHub (#3122) 2023-02-16 13:36:28 +01:00
static docs: login history (#3261) 2023-03-08 19:08:50 +00:00
.gitignore
babel.config.js
clean-generated-docs.js
docusaurus.config.js docs(a11y): update syntax highlighting theme to fix contrast issues (#3341) 2023-03-17 12:19:13 +02:00
package.json chore(deps): update dependency @babel/core to v7.21.0 (#3230) 2023-03-02 02:37:06 +00:00
README.md
sidebars.js docs: login history (#3261) 2023-03-08 19:08:50 +00:00
tsconfig.json
yarn.lock chore(deps): bump @sideway/formula from 3.0.0 to 3.0.1 in /website (#3302) 2023-03-13 10:43:29 +00:00

README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

Local Development

yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.