@yeonpm/docs-template 0.1.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/README.md +1 -2
  2. package/dist/cjs/components/CitationModal.js +1 -1
  3. package/dist/cjs/components/CitationModal.js.map +1 -1
  4. package/dist/cjs/components/CommonCard.js +1 -1
  5. package/dist/cjs/components/CommonCard.js.map +1 -1
  6. package/dist/cjs/components/CommonizeDrawer.js +1 -1
  7. package/dist/cjs/components/CommonizeDrawer.js.map +1 -1
  8. package/dist/cjs/guide/DocsGuide.js +2 -0
  9. package/dist/cjs/guide/DocsGuide.js.map +1 -0
  10. package/dist/cjs/index.js +1 -1
  11. package/dist/cjs/node_modules/tslib/tslib.es6.js +1 -1
  12. package/dist/cjs/node_modules/tslib/tslib.es6.js.map +1 -1
  13. package/dist/cjs/shell/CommonizeHeader.js +1 -1
  14. package/dist/cjs/shell/CommonizeHeader.js.map +1 -1
  15. package/dist/cjs/shell/CommonizeShell.js +1 -1
  16. package/dist/cjs/shell/CommonizeShell.js.map +1 -1
  17. package/dist/cjs/shell/CommonizeSideNav.js +1 -1
  18. package/dist/cjs/shell/CommonizeSideNav.js.map +1 -1
  19. package/dist/esm/components/CitationModal.js +1 -1
  20. package/dist/esm/components/CitationModal.js.map +1 -1
  21. package/dist/esm/components/CommonCard.js +1 -1
  22. package/dist/esm/components/CommonCard.js.map +1 -1
  23. package/dist/esm/components/CommonizeDrawer.js +1 -1
  24. package/dist/esm/components/CommonizeDrawer.js.map +1 -1
  25. package/dist/esm/guide/DocsGuide.js +2 -0
  26. package/dist/esm/guide/DocsGuide.js.map +1 -0
  27. package/dist/esm/index.js +1 -1
  28. package/dist/esm/node_modules/tslib/tslib.es6.js +1 -1
  29. package/dist/esm/node_modules/tslib/tslib.es6.js.map +1 -1
  30. package/dist/esm/shell/CommonizeHeader.js +1 -1
  31. package/dist/esm/shell/CommonizeHeader.js.map +1 -1
  32. package/dist/esm/shell/CommonizeShell.js +1 -1
  33. package/dist/esm/shell/CommonizeShell.js.map +1 -1
  34. package/dist/esm/shell/CommonizeSideNav.js +1 -1
  35. package/dist/esm/shell/CommonizeSideNav.js.map +1 -1
  36. package/dist/index.d.ts +7 -2
  37. package/package.json +14 -5
package/dist/index.d.ts CHANGED
@@ -99,7 +99,7 @@ interface CitationModalProps {
99
99
  onClose: () => void;
100
100
  publication: Publication | null;
101
101
  }
102
- declare function CitationModal({ open, onClose, publication, }: CitationModalProps): react_jsx_runtime.JSX.Element;
102
+ declare function CitationModal({ open, onClose, publication, }: CitationModalProps): react_jsx_runtime.JSX.Element | null;
103
103
 
104
104
  declare function CommonizeShell({ brand, navItems, children, headerRightSlot, navBottomSlot, }: {
105
105
  brand: CommonizeBrand;
@@ -126,6 +126,11 @@ declare function openExternal(href: string): void;
126
126
  declare function navigateToHash(id: string): void;
127
127
  declare function handleNavTarget(target: CommonizeNavTarget): void;
128
128
 
129
+ interface DocsGuideProps {
130
+ version?: string;
131
+ }
132
+ declare function DocsGuide({ version }: DocsGuideProps): react_jsx_runtime.JSX.Element;
133
+
129
134
  type CommonizeDrawerState = {
130
135
  isOpen: boolean;
131
136
  content?: CommonizeDrawerContent;
@@ -134,4 +139,4 @@ type CommonizeDrawerState = {
134
139
  };
135
140
  declare const useCommonizeDrawerStore: zustand.UseBoundStore<zustand.StoreApi<CommonizeDrawerState>>;
136
141
 
137
- export { _default as CardWrapper, CitationModal, CommonCard, type CommonCardAuthor, type CommonCardCitation, type CommonCardImage, type CommonCardLinkButton, type CommonCardProps, type CommonizeBrand, CommonizeDrawer, type CommonizeDrawerContent, CommonizeHeader, type CommonizeNavItem, type CommonizeNavTarget, CommonizeShell, CommonizeSideNav, type ReactTextLike, handleNavTarget, navigateToHash, openExternal, useCommonizeDrawerStore };
142
+ export { _default as CardWrapper, CitationModal, CommonCard, type CommonCardAuthor, type CommonCardCitation, type CommonCardImage, type CommonCardLinkButton, type CommonCardProps, type CommonizeBrand, CommonizeDrawer, type CommonizeDrawerContent, CommonizeHeader, type CommonizeNavItem, type CommonizeNavTarget, CommonizeShell, CommonizeSideNav, DocsGuide, type DocsGuideProps, type ReactTextLike, handleNavTarget, navigateToHash, openExternal, useCommonizeDrawerStore };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@yeonpm/docs-template",
3
- "version": "0.1.0",
3
+ "version": "0.3.0",
4
4
  "description": "A reusable document-style layout & card component library for React",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",
@@ -10,7 +10,9 @@
10
10
  ],
11
11
  "scripts": {
12
12
  "build": "rollup -c --bundleConfigAsCjs",
13
- "prepare": "npm run build"
13
+ "prepare": "npm run build",
14
+ "dev": "vite",
15
+ "preview": "vite preview"
14
16
  },
15
17
  "publishConfig": {
16
18
  "access": "public"
@@ -51,8 +53,6 @@
51
53
  "peerDependencies": {
52
54
  "@emotion/react": ">=11.11.0",
53
55
  "@emotion/styled": ">=11.11.0",
54
- "@mui/icons-material": ">=5.0.0",
55
- "@mui/material": ">=5.0.0",
56
56
  "@yeonpm/react": ">=1.0.0",
57
57
  "react": ">=16.8.0",
58
58
  "react-dom": ">=16.8.0",
@@ -60,15 +60,24 @@
60
60
  "zustand": ">=4.0.0"
61
61
  },
62
62
  "devDependencies": {
63
+ "@emotion/react": "^11.11.0",
64
+ "@emotion/styled": "^11.11.0",
63
65
  "@rollup/plugin-commonjs": "28.0.1",
64
66
  "@rollup/plugin-node-resolve": "15.3.0",
65
67
  "@rollup/plugin-terser": "0.4.4",
66
68
  "@rollup/plugin-typescript": "12.1.1",
67
69
  "@types/react": "^18.2.0",
68
70
  "@types/react-dom": "^18.2.0",
71
+ "@vitejs/plugin-react": "^4.2.0",
72
+ "@yeonpm/react": "^1.0.0",
73
+ "react": "^18.2.0",
74
+ "react-dom": "^18.2.0",
75
+ "react-icons": "^4.0.0",
69
76
  "rollup-plugin-dts": "6.1.1",
70
77
  "rollup-plugin-peer-deps-external": "2.2.4",
71
78
  "tslib": "2.8.1",
72
- "typescript": "^5.0.0"
79
+ "typescript": "^5.0.0",
80
+ "vite": "^5.0.0",
81
+ "zustand": "^4.0.0"
73
82
  }
74
83
  }