Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-10-27 11:02:16 +01:00
Code Issues Projects Releases Wiki Activity
2da279b7fb
unleash.unleash/website/src/css/custom.css
Thomas Heartman 415e1b0596
Source proxy and Edge docs from GitHub (#3122) 
## What

The main purpose of this PR is to

1. Delete the proxy docs in this repo and replace them with the proxy's
GitHub readme.
2. Add the docs for Unleash Edge.

### Detailed change description

This PR contains a lot of small changes in a large number of files. To
make it easier to get an overview, here's a detailed description of what
happens where:

#### In the `website/docs`directory

Except for the deletion of the proxy doc, all changes in this directory
are rewriting internal links, so that they point to the newly generated
document instead.

#### `package.json` and `yarn.lock`

When including the documentation for Edge, we also want to render the
mermaid diagrams it uses. Docusaurus supports this via a plugin. All
changes in these files are related to installing that plugin.

#### `docusaurus.config.js`

There's two types of changes in this file:

1. Mermaid-related changes: we ask docusaurus to render mermaid in
markdown files and add the plugin

2. Document generation. There's some rewrites to the sdk doc generation
plus an entirely new section that generates docs for Edge and the proxy

#### `sidebars.js`

Two things:

1. Add the edge docs
2. Move both the Edge and the proxy docs up a level, so that they're
directly under "reference docs" instead of nested inside "unleash
concepts".

#### In the `website/remote-content` directory

These are the remote content files. Previously, all of this lived only
in a `readme-fns.js` file, but with the introduction of Edge and proxy
docs, this has been moved into its own directory and refactored into
three files (`shared`, `sdks`, `edge-proxy`).

#### `custom.css`

Style updates to center mermaid diagrams and provide more space around
them.

#### In `static/img`

The image files that were included in the proxy doc and that have been
deleted.

## Why

For two reasons:

1. Reduce duplication for the proxy. Have one source of truth.
2. Add docs for edge.

## Discussion points and review wishes

This is a big PR, and I don't expect anyone to do a line-by-line review
of it, nor do I think that is particularly useful. Instead, I'd like to
ask reviewers to:

1. Visit the [documentation
preview](https://unleash-docs-git-docs-source-proxy-gh-unleash-team.vercel.app/reference/unleash-proxy)
and have a look at both the proxy docs and the Edge docs. Potentially
have a look at the SDK docs too to verify that everything still works.

2. Consider whether they think moving the proxy and edge docs up a level
(in the sidebar) makes sense.

3. Let me know what slug they'd prefer for the Edge docs. I've gone with
`unleash-edge` for now (so that it's
`docs.getunleash.io/reference/unleash-edge`), but we could potentially
also just use `edge`. WDYT?

4. Read through the detailed changes section.

5. Let me know if they have any other concerns or questions.

## Screenies

The new proxy doc:


![image](https://user-images.githubusercontent.com/17786332/219043145-1c75c83e-4191-45a3-acb5-775d05d13862.png)

The new edge doc:


![image](https://user-images.githubusercontent.com/17786332/219043220-1f5daf13-972e-4d56-8aaf-70ff1812863e.png)
2023-02-16 13:36:28 +01:00

273 lines
8.7 KiB
CSS
Raw Blame History

/* stylelint-disable docusaurus/copyright-header */
/**
* Any CSS included here will be global. The classic template
* bundles Infima by default. Infima is a CSS framework designed to
* work well for content-centric websites.
*/
/* You can override the default Infima variables here. */
:root {
--unleash-color-purple: #635dc5;
--unleash-color-gray: #ecebeb;
--ifm-code-font-size: 90%;
--ifm-font-size-base: 15px;
--navbar-link-color: #122d33;
--unleash-font-size-smaller: 90%;
}
footer {
--ifm-footer-link-hover-color: var(--ifm-footer-link-color);
}
html[data-theme='light'] {
--ifm-color-primary-lightest: #8783d2;
--ifm-color-primary-lighter: #7b76ce;
--ifm-color-primary-light: #6f6ac9;
--ifm-color-primary: var(--unleash-color-purple);
--ifm-color-primary-dark: #5953be;
--ifm-color-primary-darker: #4f4ab7;
--ifm-color-primary-darkest: #4540b0;
--ifm-menu-color-background-active: var(--unleash-color-gray);
--ifm-menu-color-background-hover: var(--unleash-color-gray);
--unleash-color-admonition-background: var(--unleash-color-gray);
--unleash-color-admonition-border: #999;
--unleash-color-admonition-text: #2b2b2b;
--ifm-background-color: #fff;
}
html[data-theme='dark'] {
--ifm-color-primary-lightest: #d1d1ff;
--ifm-color-primary-lighter: #c9c9ff;
--ifm-color-primary-light: #c2c0ff;
--ifm-color-primary: #bab8ff;
--ifm-color-primary-dark: #a09de4;
--ifm-color-primary-darker: #8582c9;
--ifm-color-primary-darkest: #6b67ae;
--unleash-color-purple: var(--ifm-color-primary);
--unleash-color-gray: #333;
--ifm-menu-color-background-active: var(--unleash-color-gray);
--ifm-menu-color-background-hover: var(--unleash-color-gray);
--ifm-link-color: var(--ifm-color-primary);
--unleash-color-admonition-background: var(
--ifm-color-secondary-contrast-background
);
--unleash-img-background-color: #fff;
--docsearch-primary-color: var(--ifm-color-primary-darkest);
}
div[class^='announcementBar_'],
div[class^='announcementBar_'] svg {
background-color: var(--ifm-color-primary);
color: var(--ifm-color-primary-contrast-background);
}
.visually-hidden {
border: 0;
clip: rect(0 0 0 0);
height: auto;
margin: 0;
overflow: hidden;
padding: 0;
position: absolute;
width: 1px;
white-space: nowrap;
}
main img {
/* give images box shadows */
box-shadow: var(--ifm-global-shadow-lw);
}
main p > img:not([src^="https://img.shields.io/" i], [src*="badge.svg?branch=" i])
{
/* give inline images a border */
border: var(--ifm-global-border-width) solid var(--unleash-color-gray);
}
main :is(p, figure) > img:not([src^="https://img.shields.io/" i], [src*="badge.svg?branch=" i])
{
/* round corners to match the rest of the page */
border-radius: var(--ifm-global-radius);
/* provide a background in case some images are partly transparent */
background: var(--unleash-img-background-color);
/* center in-text images */
display: block;
margin: auto;
}
/* mermaid diagrams */
.docusaurus-mermaid-container {
display: flex;
justify-content: center;
margin-block: calc(1.5 * var(--ifm-spacing-vertical));
}
[class^='docTitle'] {
font-size: 2.5rem !important;
}
.navbar-sidebar__back {
/* hide the 'back to main menu' item in the narrow menu. */
display: none;
}
li.theme-doc-sidebar-item-category-level-1 > div::before {
width: 0.3em;
height: 100%;
content: ' ';
background-color: var(--unleash-color-purple);
border-radius: 2px;
position: absolute;
}
.docusaurus-highlight-code-line {
background-color: rgb(72, 77, 91);
display: block;
margin: 0 calc(-1 * var(--ifm-pre-padding));
padding: 0 var(--ifm-pre-padding);
}
.header-github-link:hover {
opacity: 0.6;
}
.header-github-link:before {
content: '';
width: 24px;
height: 24px;
display: flex;
background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E")
no-repeat;
}
html[data-theme='dark'] .header-github-link:before {
background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill='white' d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E")
no-repeat;
}
/* Video content container */
.unleash-video-container {
display: grid;
--gap: 0.5em;
--border-radius: var(--ifm-alert-border-radius);
gap: var(--gap);
margin-bottom: 1em;
}
.unleash-video-container > .videos {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(120px, 1fr));
gap: var(--gap);
}
.unleash-video-container > .admonition {
box-shadow: none;
background-color: var(--unleash-color-admonition-background);
color: var(--unleash-color-admonition-text);
border-color: var(--unleash-color-admonition-border);
margin: 0;
}
.unleash-video-container iframe {
aspect-ratio: 16/9;
}
@media screen and (min-width: 450px) {
.unleash-video-container {
grid-template-columns: 1fr min(250px, 25%);
}
.unleash-video-container > .videos {
display: flex;
flex-direction: column;
gap: var(--gap);
}
}
/* end video content container */
/* docusaurus-plugin-openapi-docs styling
Taken from
https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/02922a6ad6d635373e01409dac8c17a88da2b72e/demo/src/css/custom.css#L45-L9
Based on this thread:
https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/issues/177
*/
/* Sidebar Method labels */
.api-method > .menu__link {
align-items: center;
justify-content: start;
}
.api-method > .menu__link::before {
width: 50px;
height: 20px;
font-size: 12px;
line-height: 20px;
text-transform: uppercase;
font-weight: 600;
border-radius: 0.25rem;
border: 1px solid;
border-inline-start-width: 5px;
margin-right: var(--ifm-spacing-horizontal);
text-align: center;
flex-shrink: 0;
}
.get > .menu__link::before {
content: 'get';
background-color: var(--ifm-color-info-contrast-background);
color: var(--ifm-color-info-contrast-foreground);
border-color: var(--ifm-color-info-dark);
}
.post > .menu__link::before {
content: 'post';
background-color: var(--ifm-color-success-contrast-background);
color: var(--ifm-color-success-contrast-foreground);
border-color: var(--ifm-color-success-dark);
}
.delete > .menu__link::before {
content: 'del';
background-color: var(--ifm-color-danger-contrast-background);
color: var(--ifm-color-danger-contrast-foreground);
border-color: var(--ifm-color-danger-dark);
}
.put > .menu__link::before {
content: 'put';
background-color: var(--ifm-color-warning-contrast-background);
color: var(--ifm-color-warning-contrast-foreground);
border-color: var(--ifm-color-warning-dark);
}
.patch > .menu__link::before {
content: 'patch';
background-color: var(--ifm-color-success-contrast-background);
color: var(--ifm-color-success-contrast-foreground);
border-color: var(--ifm-color-success-dark);
}
.head > .menu__link::before {
content: 'head';
background-color: var(--ifm-color-secondary-contrast-background);
color: var(--ifm-color-secondary-contrast-foreground);
border-color: var(--ifm-color-secondary-dark);
}
Reference in New Issue View Git Blame Copy Permalink