docs: create docs workspace (#5174)

* docs: migrate ui docs to docs universe

* created yarn workspace

* added eslint and tsconfig configurations

* fix eslint configurations

* fixed eslint configurations

* shared tailwind configurations

* added shared ui package

* added more shared components

* migrating more components

* made details components shared

* move InlineCode component

* moved InputText

* moved Loading component

* Moved Modal component

* moved Select components

* Moved Tooltip component

* moved Search components

* moved ColorMode provider

* Moved Notification components and providers

* used icons package

* use UI colors in api-reference

* moved Navbar component

* used Navbar and Search in UI docs

* added Feedback to UI docs

* general enhancements

* fix color mode

* added copy colors file from ui-preset

* added features and enhancements to UI docs

* move Sidebar component and provider

* general fixes and preparations for deployment

* update docusaurus version

* adjusted versions

* fix output directory

* remove rootDirectory property

* fix yarn.lock

* moved code component

* added vale for all docs MD and MDX

* fix tests

* fix vale error

* fix deployment errors

* change ignore commands

* add output directory

* fix docs test

* general fixes

* content fixes

* fix announcement script

* added changeset

* fix vale checks

* added nofilter option

* fix vale error
This commit is contained in:
Shahed Nasser
2023-09-21 20:57:15 +03:00
committed by GitHub
parent 19c5d5ba36
commit fa7c94b4cc
3209 changed files with 32188 additions and 31018 deletions

View File

@@ -0,0 +1,10 @@
export function checkArraySameElms(
arr1: Array<any>,
arr2: Array<any>
): boolean {
if (arr1.length !== arr2.length) {
return false
}
return arr1.every((value, index) => value === arr2[index])
}

View File

@@ -0,0 +1,3 @@
export function capitalize(str: string): string {
return str.charAt(0).toUpperCase() + str.slice(1).toLowerCase()
}

View File

@@ -0,0 +1,21 @@
export function checkSidebarItemVisibility(
item: Element,
options?: {
topMargin?: number
}
) {
const sidebar = document.getElementById("sidebar")
if (!sidebar) {
return false
}
const { topMargin = 0 } = options || {}
const sidebarBoundingRect = sidebar.getBoundingClientRect()
const activeItemBoundingRect = item.getBoundingClientRect()
return (
activeItemBoundingRect.top >= topMargin &&
activeItemBoundingRect.top - sidebarBoundingRect.height + topMargin < 0 &&
activeItemBoundingRect.bottom > 0
)
}

View File

@@ -0,0 +1,29 @@
export function findPrevSibling(
element: HTMLElement,
selector: string
): HTMLElement | null {
let prevElement = element.previousElementSibling
while (prevElement !== null) {
if (prevElement.matches(selector)) {
return prevElement as HTMLElement
}
prevElement = prevElement.previousElementSibling
}
return null
}
export function findNextSibling(
element: HTMLElement,
selector: string
): HTMLElement | null {
let nextElement = element.nextElementSibling
while (nextElement !== null) {
if (nextElement.matches(selector)) {
return nextElement as HTMLElement
}
nextElement = nextElement.nextElementSibling
}
return null
}

View File

@@ -0,0 +1,7 @@
import { GITHUB_ISSUES_PREFIX } from "../constants"
export function formatReportLink(title: string, sectionTitle: string) {
return `${GITHUB_ISSUES_PREFIX}&title=${encodeURI(
title
)}%3A%20Issue%20in%20${encodeURI(sectionTitle)}`
}

View File

@@ -0,0 +1,5 @@
export * from "./array-same-elms"
export * from "./capitalize"
export * from "./check-sidebar-item-visibility"
export * from "./dom-utils"
export * from "./format-report-link"