Merge pull request #100 from 8845musign/fix-props-table

Show props that were not displayed
ubie-oss · Nov 27, 2024 · e1bb636 · e1bb636
2 parents cac2e68 + ce96d11
commit e1bb636
Show file tree

Hide file tree

Showing 40 changed files with 736 additions and 213 deletions.
diff --git a/README.md b/README.md
@@ -34,3 +34,7 @@ Implement the most basic example.
 ```
 npm run generate:page:example
 ```
+### Component page props
+
+The props are automatically extracted using `react-docgen`. However, complex props cannot be extracted.
+In that case, they can be displayed by describing them in the mdx file frontmatter.prop. By using keywords such as `{TextColor}` and `{Spacing}`, you can omit the description of frequently used values (see src/utils/server/props/typeSetKeyword.ts for details).
diff --git a/package-lock.json b/package-lock.json