chore(docs): Refactor API Reference (#1883)

This commit is contained in:
Shahed Nasser authored and GitHub committed 2022-08-05 14:06:12 +02:00
1 parent b126ab4dec
commit 73383cc466
625 files changed
+52358 -11660

No files matched your search

-56
View File
@@ -1,56 +0,0 @@
import React, { useEffect, useState } from "react"
import CloseIcon from "../close-icon"
import ConfLogo from "../../../static/img/logo.svg"
import clsx from "clsx"
import styles from "./banner.module.css"
import {useColorMode} from '@docusaurus/theme-common';
const Banner = (props) => {
const [isBannerVisible, setIsBannerVisible] = useState(true)
const { isDarkTheme } = useColorMode()
const handleDismissBanner = () => {
setIsBannerVisible(false)
if (localStorage) {
localStorage.setItem("mc::banner", false)
}
}
useEffect(() => {
if (localStorage) {
const shouldShow = localStorage.getItem("mc::banner")
if (!shouldShow) {
setIsBannerVisible(true)
}
if (shouldShow === "false") {
setIsBannerVisible(false)
}
}
}, [])
return (
isBannerVisible && (
<div className={clsx(styles.bannerContainer, "margin-top--lg")}>
<div
className={clsx(styles.banner, "padding--sm", "padding-right--md")}
>
<div className="padding" sx={{ marginLeft: "10px" }}>
<ConfLogo />
<p className="padding-left--md">
We are still working on building out our documentation and guides,
but if you are interested in learning more please reach out - we
would love to jump on a call with you and help you get set up!
</p>
</div>
{/* <div style={{ cursor: "pointer" }} onClick={handleDismissBanner}>
<CloseIcon fill={isDarkTheme ? "white" : "black"} />
</div> */}
</div>
</div>
)
)
}
export default Banner
@@ -1,18 +0,0 @@
.bannerContainer {
height: 100%;
padding: 10px 0px;
margin-bottom: 20px;
background-color: var(--ifm-medusa-gray);
border-radius: 5px;
}
.bannerContainer svg {
max-width: 100px;
margin-left: 15px;
}
.banner {
display: flex;
flex-direction: row;
justify-content: space-between;
}
-1
View File
@@ -1 +0,0 @@
export { default as Banner } from "./Banner"
+2 -1
View File
@@ -1,4 +1,5 @@
import React from "react"
import React, { useEffect } from "react"
import RootLayout from "@theme/Layout"
const Layout = ({ children, ...props }) => {
@@ -11,5 +11,4 @@
color: var(--ifm-color-primary);
border-bottom: 3px solid var(--ifm-color-primary) !important;
font-weight: 500;
transition: ;
}
+10 -1
View File
@@ -284,7 +284,7 @@ details summary {
cursor: pointer;
}
.theme-doc-markdown a:not(.box-link):hover {
[data-theme="dark"] .theme-doc-markdown a.card:hover {
color: rgba(255, 255, 255, 0.8);
text-decoration: none;
}
@@ -317,4 +317,13 @@ details summary {
max-width: 100%;
word-break: break-word;
white-space: break-spaces;
}
/* API Reference Styling */
html[data-theme="dark"] .redocusaurus .expanded + tr > td > div {
background-color: var(--ifm-medusa-gray);
}
.redocusaurus a {
color: var(--ifm-link-color) !important;
}
+1
View File
@@ -9,6 +9,7 @@ import clsx from 'clsx';
import isInternalUrl from '@docusaurus/isInternalUrl';
import styles from './styles.module.css';
import {translate} from '@docusaurus/Translate';
function CardContainer({href, children}) {
return (
<Link
+62
View File
@@ -0,0 +1,62 @@
import React, { useEffect, useState } from 'react';
import Redoc from '@theme-original/Redoc';
import useIsBrowser from '@docusaurus/useIsBrowser';
export default function RedocWrapper(props) {
const isBrowser = useIsBrowser();
const [loading, setLoading] = useState(isBrowser ? document.readyState !== 'complete' : true)
useEffect(() => {
if (isBrowser) {
//redocusaurus in dark mode displays styling wrong
//until the issue is resolved, this is a work around to hide
//the bad styling
window.onload = function () {
setLoading(false);
}
//fallback in case the onload function does not execute
setTimeout(() => {
if (loading) {
setLoading(false);
}
}, 1000)
function scrollHandler () {
const redocSidebar = document.querySelector('.redocusaurus .menu-content');
const navbar = document.querySelector('.navbar');
if (!redocSidebar || !navbar) {
return;
}
let offset = navbar.clientHeight;
for (let [_, className] of navbar.classList.entries()) {
if (className.indexOf('navbarHidden') !== -1) {
offset = 0;
break;
}
}
redocSidebar.style.top = `${offset}px`
}
window.addEventListener('scroll', scrollHandler);
return () => {
window.removeEventListener('scroll', scrollHandler);
}
}
}, [isBrowser])
return (
<div style={{
opacity: loading ? 0 : 1,
transition: 'opacity 0.2s'
}}>
<Redoc {...props} />
</div>
);
}
+1
View File
@@ -22,6 +22,7 @@ import clsx from 'clsx';
import styles from './styles.module.css';
import {useAllDocsData} from '@docusaurus/plugin-content-docs/client';
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
// Very simple pluralization: probably good enough for now
function useDocumentsFoundPlural() {
const {selectMessage} = usePluralForm();