asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: generate documentation for UI components (#5849)

Browse Source 
* added tool to generate spec files for React components

* use typedoc for missing descriptions and types

* improvements and fixes

* improvements

* added doc comments for half of the components

* add custom resolver + more doc comments

* added all tsdocs

* general improvements

* add specs to UI docs

* added github action

* remove unnecessary api route

* Added readme for react-docs-generator

* remove comment

* Update packages/design-system/ui/src/components/currency-input/currency-input.tsx

Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>

* remove description of aria fields + add generate script

---------

Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>
This commit is contained in:
Shahed Nasser
2023-12-13 16:02:41 +02:00
committed by GitHub
co-authored by Kasper Fabricius Kristensen
parent edc49bfe1d
commit 245e5c9a69
288 changed files with 6029 additions and 1447 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/packages/docs-ui/src/components/MarkdownContent/index.tsx
+86 -71
View File
@@ -3,85 +3,100 @@ import ReactMarkdown from "react-markdown"
import { ReactMarkdownOptions } from "react-markdown/lib/react-markdown"
import { CodeMdx, Details, Kbd, Link } from "@/components"
import clsx from "clsx"
import { NormalComponents } from "react-markdown/lib/complex-types"
import { SpecialComponents } from "react-markdown/lib/ast-to-react"
export type MarkdownContentProps = ReactMarkdownOptions
export type MarkdownContentProps = ReactMarkdownOptions & {
components?: Partial<
Omit<NormalComponents, keyof SpecialComponents> & SpecialComponents
>
}
export const MarkdownContent = ({
children,
components,
...props
}: MarkdownContentProps) => {
return (
<ReactMarkdown
components={{
code: CodeMdx,
pre: ({
className,
children,
...props
}: React.HTMLAttributes<HTMLPreElement>) => {
return (
<pre className={clsx("p-0 bg-transparent", className)} {...props}>
{children}
</pre>
)
},
kbd: Kbd,
details: Details,
a: Link,
ul: ({
className,
children,
...props
}: React.HTMLAttributes<HTMLUListElement>) => {
return (
<ul
{...props}
className={clsx("list-disc px-docs_1 mb-docs_1.5", className)}
>
{children}
</ul>
)
},
ol: ({
className,
children,
...props
}: React.HTMLAttributes<HTMLOListElement>) => {
return (
<ol
{...props}
className={clsx("list-decimal px-docs_1 mb-docs_1.5", className)}
>
{children}
</ol>
)
},
li: ({
className,
children,
...props
}: React.HTMLAttributes<HTMLLIElement>) => {
return (
<li className={clsx("text-medusa-fg-subtle", className)} {...props}>
<span>{children}</span>
</li>
)
},
p: ({
className,
...props
}: React.HTMLAttributes<HTMLParagraphElement>) => {
return (
<p
className={clsx(
"text-medusa-fg-subtle [&:not(:last-child)]:mb-docs_1.5 last:!mb-0",
className
)}
{...props}
/>
)
},
}}
components={
components || {
code: CodeMdx,
pre: ({
className,
children,
...props
}: React.HTMLAttributes<HTMLPreElement>) => {
return (
<pre className={clsx("p-0 bg-transparent", className)} {...props}>
{children}
</pre>
)
},
kbd: Kbd,
details: Details,
a: Link,
ul: ({
className,
children,
...props
}: React.HTMLAttributes<HTMLUListElement>) => {
return (
<ul
{...props}
className={clsx("list-disc px-docs_1 mb-docs_1.5", className)}
>
{children}
</ul>
)
},
ol: ({
className,
children,
...props
}: React.HTMLAttributes<HTMLOListElement>) => {
return (
<ol
{...props}
className={clsx(
"list-decimal px-docs_1 mb-docs_1.5",
className
)}
>
{children}
</ol>
)
},
li: ({
className,
children,
...props
}: React.HTMLAttributes<HTMLLIElement>) => {
return (
<li
className={clsx("text-medusa-fg-subtle", className)}
{...props}
>
<span>{children}</span>
</li>
)
},
p: ({
className,
...props
}: React.HTMLAttributes<HTMLParagraphElement>) => {
return (
<p
className={clsx(
"text-medusa-fg-subtle [&:not(:last-child)]:mb-docs_1.5 last:!mb-0",
className
)}
{...props}
/>
)
},
}
}
{...props}
>
{children}