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
+40
View File
@@ -0,0 +1,40 @@
"use client"
import {
ColorModeProvider,
MobileProvider,
ModalProvider,
NavbarProvider,
AnalyticsProvider,
ScrollControllerProvider,
} from "docs-ui"
import SearchProvider from "./search"
import SidebarProvider from "./sidebar"
type ProvidersProps = {
children: React.ReactNode
}
const Providers = ({ children }: ProvidersProps) => {
return (
<AnalyticsProvider writeKey={process.env.NEXT_PUBLIC_SEGMENT_API_KEY}>
<MobileProvider>
<ColorModeProvider>
<ModalProvider>
<SidebarProvider>
<NavbarProvider basePath={process.env.NEXT_PUBLIC_BASE_PATH}>
<SearchProvider>
<ScrollControllerProvider>
{children}
</ScrollControllerProvider>
</SearchProvider>
</NavbarProvider>
</SidebarProvider>
</ModalProvider>
</ColorModeProvider>
</MobileProvider>
</AnalyticsProvider>
)
}
export { Providers }
+70
View File
@@ -0,0 +1,70 @@
"use client"
import { SearchProvider as UiSearchProvider } from "docs-ui"
import { absoluteUrl } from "../lib/absolute-url"
type SearchProviderProps = {
children: React.ReactNode
}
const SearchProvider = ({ children }: SearchProviderProps) => {
return (
<UiSearchProvider
algolia={{
appId: process.env.NEXT_PUBLIC_ALGOLIA_APP_ID || "temp",
apiKey: process.env.NEXT_PUBLIC_ALGOLIA_API_KEY || "temp",
mainIndexName:
process.env.NEXT_PUBLIC_DOCS_ALGOLIA_INDEX_NAME || "temp",
indices: [
process.env.NEXT_PUBLIC_API_ALGOLIA_INDEX_NAME || "temp",
process.env.NEXT_PUBLIC_DOCS_ALGOLIA_INDEX_NAME || "temp",
],
}}
searchProps={{
isLoading: false,
suggestions: [
{
title: "Search Suggestions",
items: ["Install in Admin Extension", "Icons", "Colors"],
},
],
checkInternalPattern: new RegExp(`^${absoluteUrl()}/ui`),
filterOptions: [
{
value: "admin",
label: "Admin API",
},
{
value: "store",
label: "Store API",
},
{
value: "docs",
label: "Docs",
},
{
value: "user-guide",
label: "User Guide",
},
{
value: "plugins",
label: "Plugins",
},
{
value: "reference",
label: "References",
},
{
value: "ui",
label: "UI",
},
],
}}
initialDefaultFilters={["ui"]}
>
{children}
</UiSearchProvider>
)
}
export default SearchProvider
+19
View File
@@ -0,0 +1,19 @@
import { SidebarProvider as UiSidebarProvider } from "docs-ui"
import { docsConfig } from "@/config/docs"
type SidebarProviderProps = {
children?: React.ReactNode
}
const SidebarProvider = ({ children }: SidebarProviderProps) => {
return (
<UiSidebarProvider
initialItems={docsConfig.sidebar}
shouldHandlePathChange={true}
>
{children}
</UiSidebarProvider>
)
}
export default SidebarProvider