docs: refactor to use TypeScript, ESLint, and Tailwind CSS (#4136)

* docs(refactoring): configured eslint and typescript (#3511)

* docs: configured eslint and typescript

* fixed yarn.lock

* docs(refactoring): migrate components directory to typescript (#3517)

* docs: migrate components directory to typescript

* removed vscode settings

* fix following merge

* docs: refactored QueryNote component (#3576)

* docs: refactored first batch of theme components (#3579)

* docs: refactored second batch of theme components (#3580)

* added missing badge styles

* fix after merge

* docs(refactoring): migrated remaining component to TypeScript (#3770)

* docs(refactoring): configured eslint and typescript (#3511)

* docs: configured eslint and typescript

* fixed yarn.lock

* docs(refactoring): migrate components directory to typescript (#3517)

* docs: migrate components directory to typescript

* removed vscode settings

* fix following merge

* docs: refactored QueryNote component (#3576)

* docs: refactored first batch of theme components (#3579)

* docs: refactored second batch of theme components (#3580)

* added missing badge styles

* docs: refactoring second batch of theme components

* fix after merge

* refactored icons and other components

* docs: refactored all components

* docs(refactoring): set up and configured Tailwind Css (#3841)

* docs: added tailwind config

* docs: added more tailwind configurations

* add includes option

* added more tailwind configurations

* fix to configurations

* docs(refactoring): use tailwind css (#4134)

* docs: added tailwind config

* docs: added more tailwind configurations

* add includes option

* added more tailwind configurations

* fix to configurations

* docs(refactoring): refactored all styles to use tailwind css (#4132)

* refactored Badge component to use tailwind css

* refactored Bordered component to use tailwind css

* updated to latest docusaurus

* refactored BorderedIcon component to use tailwind css

* refactored Feedback component to use tailwind css

* refactored icons and footersociallinks to tailwind css

* start refactoring of large card

* refactored large card styling

* refactored until admonitions

* refactored until codeblock

* refactored until Tabs

* refactored Tabs (without testing

* finished refactoring styles to tailwind css

* upgraded to version 2.4.1

* general fixes

* adjusted eslint configurations

* fixed ignore files

* fixes to large card

* fix search styling

* fix npx command

* updated tabs to use isCodeTabs prop

* fixed os tabs

* removed os-tabs class in favor of general styling

* improvements to buttons

* fix for searchbar

* fixed redocly download button

* chore: added eslint code action (#4135)

* small change in commerce modules page
This commit is contained in:
Shahed Nasser
2023-05-19 14:56:48 +03:00
committed by GitHub
parent 29a88bbf98
commit 94907730d2
292 changed files with 11721 additions and 42102 deletions

View File

@@ -1,11 +1,17 @@
import { PropSidebarItem, PropSidebarItemLink } from '@docusaurus/plugin-content-docs'
import {
PropSidebarItem,
PropSidebarItemLink,
} from "@docusaurus/plugin-content-docs"
export default function filterListItems (items: PropSidebarItemLink[], pathPattern: string | RegExp): PropSidebarItemLink[] {
export default function filterListItems(
items: PropSidebarItemLink[],
pathPattern: string | RegExp
): PropSidebarItemLink[] {
if (!items.length) {
return items
}
let pattern = new RegExp(pathPattern)
const pattern = new RegExp(pathPattern)
return items.filter((item: PropSidebarItemLink) => pattern.test(item.href))
}
@@ -14,9 +20,9 @@ export default function filterListItems (items: PropSidebarItemLink[], pathPatte
* Flatting a sidebar list moving items from category
* to links
*/
export function flattenList (items: PropSidebarItem[]): PropSidebarItem[] {
export function flattenList(items: PropSidebarItem[]): PropSidebarItem[] {
const newItems = items.map((item: PropSidebarItem) => {
if (item.type !== 'category') {
if (item.type !== "category") {
return item
}
@@ -24,4 +30,4 @@ export function flattenList (items: PropSidebarItem[]): PropSidebarItem[] {
})
return newItems.flat()
}
}

View File

@@ -1,6 +1,14 @@
import { findSidebarCategory, useDocsSidebar } from '@docusaurus/theme-common/internal';
import { PropSidebarItem } from '@docusaurus/plugin-content-docs';
import {
findSidebarCategory,
useDocsSidebar,
} from "@docusaurus/theme-common/internal"
import { PropSidebarItem } from "@docusaurus/plugin-content-docs"
export default function getFirstCategoryItem (categoryLabel: string): PropSidebarItem | undefined {
return findSidebarCategory(useDocsSidebar().items, (item) => item.label === categoryLabel)?.items[0];
}
export default function getFirstCategoryItem(
categoryLabel: string
): PropSidebarItem | undefined {
return findSidebarCategory(
useDocsSidebar().items,
(item) => item.label === categoryLabel
)?.items[0]
}

View File

@@ -3,23 +3,25 @@ function reverseSidebarItems(sidebarItems, categoryItem) {
if (categoryItem.customProps?.reverse) {
// Reverse items in categories
result = result.map((item) => {
if (item.type === 'category') {
return {...item, items: reverseSidebarItems(item.items, categoryItem)};
if (item.type === "category") {
return { ...item, items: reverseSidebarItems(item.items, categoryItem) }
}
return item;
});
return item
})
// Reverse items at current level
// use localeCompare since the reverse array method doesn't account for
// numeric strings
result.sort((a, b) => {
const aToCompare = a.id || a.href || a.value || ""
const bToCompare = b.id || b.href || b.value || ""
const comparison = aToCompare.localeCompare(bToCompare, undefined, { numeric: true })
const comparison = aToCompare.localeCompare(bToCompare, undefined, {
numeric: true,
})
return comparison < 0 ? 1 : (comparison > 0 ? -1 : 0)
return comparison < 0 ? 1 : comparison > 0 ? -1 : 0
})
}
return result;
return result
}
module.exports = reverseSidebarItems
module.exports = reverseSidebarItems