{"_id":"@axiomatrix/dumi-theme-chakra","name":"@axiomatrix/dumi-theme-chakra","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"@axiomatrix/dumi-theme-chakra","version":"0.0.1","description":"Chakra theme for dumi2, updated by Axiomatrix Org.","types":"dist/types.d.ts","main":"dist/cjs/index.js","scripts":{"dev":"run-p dev:*","build":"run-s build:*","dev:father":"father dev","dev:example":"pnpm -F ./example run start","build:father":"father build","build:example":"pnpm -F ./example run build","preview":"cd ./serve && deno task dev","up:deps":"pnpm up","prepare":"husky install && father link-dev-theme","lint":"pnpm run lint:es && pnpm run lint:css","lint:css":"stylelint \"{src,test}/**/*.{css,less}\"","lint:es":"eslint \"{src,test}/**/*.{js,jsx,ts,tsx}\"","prepublishOnly":"father doctor && pnpm run build:father","version":"changeset && changeset version","release":"changeset publish"},"keywords":["dumi","dumi-theme","chakra"],"authors":["Axiomatrix Org. "],"license":"MIT","commitlint":{"extends":["@commitlint/config-conventional"]},"lint-staged":{"*.{md,json}":["prettier --write --no-error-on-unmatched-pattern"],"*.{css,less}":["stylelint --fix","prettier --write"],"*.{js,jsx}":["eslint --fix","prettier --write"],"*.{ts,tsx}":["eslint --fix","prettier --parser=typescript --write"]},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org"},"peerDependencies":{"dumi":"^2.0.12","react":">=16.9.0","react-dom":">=16.9.0"},"devDependencies":{"@changesets/changelog-github":"^0.4.8","@changesets/cli":"^2.26.2","@commitlint/cli":"^17.6.7","@commitlint/config-conventional":"^17.6.7","@types/react":"^18.2.15","@types/react-copy-to-clipboard":"^5.0.4","@types/react-dom":"^18.2.7","@umijs/lint":"^4.0.72","dumi":"^2.2.1","dumi-assets-types":"^1.0.1","eslint":"^8.45.0","father":"^4.2.3","father-plugin-dumi-theme":"1.0.0-rc.1","husky":"^8.0.3","lint-staged":"^13.2.3","npm-run-all":"^4.1.5","prettier":"^2.8.8","prettier-plugin-organize-imports":"^3.2.3","prettier-plugin-packagejson":"^2.4.5","react":"^18.2.0","react-dom":"^18.2.0","stylelint":"^14.16.1"},"dependencies":{"@babel/runtime":"^7.22.6","@chakra-ui/icons":"^2.1.0","@chakra-ui/react":"^2.8.0","@chakra-ui/theme-tools":"^2.1.0","@docsearch/css":"^3.5.1","@docsearch/react":"^3.5.1","@emotion/react":"^11.11.1","@emotion/styled":"^11.11.0","@fontsource-variable/inter":"^5.0.5","@makotot/ghostui":"^2.0.0","animated-scroll-to":"^2.3.0","clsx":"^1.2.1","cmdk":"^0.1.22","framer-motion":"^7.10.3","heti":"^0.9.4","prism-react-renderer":"^1.3.5","react-copy-to-clipboard":"^5.1.0","react-icons":"^4.10.1"},"engines":{"node":">=14"},"repository":{"type":"git","url":"git+https://github.com/KynixInHK/dumi-theme-chakra.git","branch":"main"},"_id":"@axiomatrix/dumi-theme-chakra@0.0.1","gitHead":"cb9b2e681f909bde282f8fb6cc09f37f1f772137","bugs":{"url":"https://github.com/KynixInHK/dumi-theme-chakra/issues"},"homepage":"https://github.com/KynixInHK/dumi-theme-chakra#readme","_nodeVersion":"20.15.1","_npmVersion":"10.7.0","dist":{"integrity":"sha512-EAzr5KC/GaqE/ACOPPnKkjjTgcbm6IM7gzX66KEzeg+x1afnC3Pbm/BuwWP/CUEtO4JQZQFz4DUKEeUDKkZ2yw==","shasum":"ad83c595248b612d8a5b976b6f8d7d908a470a38","tarball":"https://registry.npmjs.org/@axiomatrix/dumi-theme-chakra/-/dumi-theme-chakra-0.0.1.tgz","fileCount":228,"unpackedSize":1088373,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCNy445IQLlLIaKGQ05eO8aCWhJUVD+BCnzesBOtAip5AIhAMbYgklf9E/RJsUWGFAxyckIJUyvY8sTuaxnNkOnuX80"}]},"_npmUser":{"name":"kynixtw","email":"kynixcn@gmail.com"},"directories":{},"maintainers":[{"name":"kynixtw","email":"kynixcn@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dumi-theme-chakra_0.0.1_1721727871313_0.03105717596629587"},"_hasShrinkwrap":false}},"time":{"created":"2024-07-23T09:44:31.206Z","0.0.1":"2024-07-23T09:44:31.482Z","modified":"2024-07-23T09:44:31.740Z"},"maintainers":[{"name":"kynixtw","email":"kynixcn@gmail.com"}],"description":"Chakra theme for dumi2, updated by Axiomatrix Org.","homepage":"https://github.com/KynixInHK/dumi-theme-chakra#readme","keywords":["dumi","dumi-theme","chakra"],"repository":{"type":"git","url":"git+https://github.com/KynixInHK/dumi-theme-chakra.git","branch":"main"},"bugs":{"url":"https://github.com/KynixInHK/dumi-theme-chakra/issues"},"license":"MIT","readme":"

\n \n \"dumi-theme-chakra\n \n
\n

\n \n English | \n Chinese\n \n

\n

\n
\n

\n \"npm\n \"node\n \"build\n \"discord\n

\n
\n
\n

Chakra theme for dumi2

\n

\n\n## Usage\n\n```bash\n# npm\n$ npm i dumi-theme-chakra -D\n# yarn\n$ yarn add dumi-theme-chakra -D\n# pnpm\n$ pnpm add dumi-theme-chakra -D\n```\n\n## Configure\n\nconfigure it in dumi config file `.dumirc.ts`:\n\n```ts\nimport { defineConfig } from 'dumi';\nimport { defineThemeConfig } from 'dumi-theme-chakra';\n\nexport defineConfig({\n themeConfig: {\n ...defineThemeConfig({\n // ...\n })\n },\n});\n```\n\n## Options\n\n```tsx\nexport type ThemeConfig = DocProviderProps & {\n /**\n * @description socails config: like github & discord\n */\n social?: SocialMap;\n /**\n * @description splitor of helmet generate word: ${themeConfig.title} ${helmetIcon} ${subTitle}\n */\n helmetIcon?: string;\n /**\n * @description head meta description\n */\n description?: string;\n /**\n * @description head meta keywords\n */\n keywords?: string[];\n /**\n * @description head meta author\n */\n author?: string;\n /**\n * @description whether use search feature, when boolean, open or close. use object to config more\n * @default true\n */\n search?: boolean | Search;\n /**\n * @description announcementBar of top container setting\n */\n announcementBar?: AnnouncementBarConfig;\n /**\n * @description hero setting for homepage\n */\n hero?: HeroConfig;\n /**\n * @description doc body background image. if boolean. use default background image\n * @default false\n */\n thumbBackground?: boolean | string;\n /**\n * @description setting panel visiblity\n * @default false\n */\n settingPanelVisible?: boolean;\n /**\n * @description setting\n */\n code?: {\n /**\n * @description prism themes\n * @default { dark: PRISMTHEME.VSDARK, light: PRISMTHEME.VSLIGHT }\n */\n theme?: CodeTheme;\n };\n};\n```\n\nto learn more, [see](./src/types.ts)\n\n## Contribution\n\nSee [Contributing Guide](CONTRIBUTING.md).\n\n## License\n\n[MIT](LICENSE).\n\n## Sponsoring\n\n\n \n \n \n \n
\n \n \n \n \n \n \n \n
\n","readmeFilename":"README.md"}