hub / github.com/arvinxx/dumi-theme-antd-style
github.com/arvinxx/dumi-theme-antd-style @v0.31.1
Chat with this repo
164 symbols
486 edges
151 files
1 documented · 1%
1 cross-repo links
● updated 5mo agov0.31.1 · 2024-08-06★ 8731 open issues
What it actually does AI analysis from the code graph — generated when you open this
loading…
README
dumi-theme-antd-style
一款为 dumi2 打造的文档站主题包，提供了更加美观、易用的研发与阅读体验
Changelog · Report Bug · Request Feature
简介
dumi-theme-antd-style 是为 dumi2 打造的一款文档站主题包，提供了更加美观、易用的研发与阅读体验
特性
- 💠 现代化主题风格 ： 本主题包采用了流动色、毛玻璃、光影质感、自然动效等现代化的设计表现手法，将界面以更加简约、美观的方式呈现，使得文档更加直观、易读、易用；
- 🌓 亮暗色主题模式一键切换： 基于 antd v5 自定义了亮色与暗色主题算法，默认提供美观易用的亮暗色主题。用户可以根据自己的喜好选择主题模式，在不同的光线环境下都能获得良好的阅读体验。
- 💅 基于 Ant Design 与 CSSinJS： 本主题包使用 antd 作为基础组件库，并使用了 CSSinJS 实现样式方案，帮助更好地控制样式的细节，提高样式的复用性和可维护性。底层使用了 antd-style 样式库，在书写样式上更加灵活、可读、易于维护。
- 🪄 精美的语法高亮： 本主题包提供准确、精美的语法高亮特性。底层采用了现代化的语法高亮库 Shiki 与 Prism，并提供了丰富的代码高亮方案，帮助用户更好地阅读代码；
- 🧩 组件灵活复用： 本主题包为本地主题定制提供了很高的灵活度，默认导出了主题包中的精品组件，可以将组件作为独立的模块进行复用，开发者可以在 dumi 本地主题包中自由组合使用；
- 📱 移动端适配良好： 本主题包对移动端适配良好，基于 CSSinJS 的灵活样式方案，多套布局实现轻而易举。用户多端操作体验一致且顺滑；
快速上手
安装
推荐使用 pnpm 安装
pnpm i dumi-theme-antd-style -D
使用
安装完毕后，使用 dumi 启动站点，dumi 会自动加载主题，即可开始使用。
配置详情查看 文档配置。
更新日志
详情：CHANGELOG
🤝 Contributing
📊 Total: 14
📝 License
Copyright © 2020 - present Arvin Xu.
This project is MIT licensed.
Extension points exported contracts — how you extend this code
AdjustParams (Interface)* @title 阴影参数
src/styles/algorithms/utils/paletteGenerator.ts
ApiHeaderProps (Interface)
(no doc)
src/types/apiHeader.ts
ThemeSwitchProps (Interface)
(no doc)
src/components/ThemeSwitch/index.tsx
SiteStore (Interface)
(no doc)
src/store/useSiteStore.ts
IContentTabsProps (Interface)
(no doc)
src/slots/ContentTabs/index.tsx
SourceCodeProps (Interface)
(no doc)
src/builtins/SourceCode/index.tsx
Theme (Interface)
(no doc)
typings/global.d.ts
CustomStylish (Interface)
(no doc)
src/styles/customStylish.ts
Core symbols most depended-on inside this repo
localeValueSelcalled by 17
src/store/selectors/hero.ts
safeFixed
called by 9
src/builtins/ColorPalettes/ColorPalette.tsx
useSyncState
called by 6
src/components/StoreUpdater/index.tsx
generateColorPalette
called by 6
src/styles/algorithms/utils/paletteGenerator.ts
merge
called by 5
src/components/StoreUpdater/useRouteMeta.ts
apiHeaderSel
called by 5
src/store/selectors/apiHeader.ts
getTargetLocalePath
called by 4
src/slots/LangSwitch/index.tsx
overwriteAlert
called by 4
src/builtins/Container/style.ts
Shape
Languages
TypeScript100%
Modules by API surface
src/components/NativeSelect/index.tsx10 symbols
src/components/LazyLoad/index.tsx8 symbols
src/store/selectors/hero.ts7 symbols
src/styles/algorithms/utils/paletteGenerator.ts6 symbols
src/components/ThemeSwitch/index.tsx6 symbols
src/store/selectors/index.ts5 symbols
src/store/selectors/apiHeader.ts5 symbols
src/builtins/ColorPalettes/ColorPalette.tsx5 symbols
src/slots/PreviewerActionsExtra/index.tsx4 symbols
src/components/StoreUpdater/index.tsx4 symbols
src/components/Highlighter/useShiki.ts4 symbols
src/types/hero.ts3 symbols
Used by 1 indexed graphs manifest dependencies, hub-wide
For agents
$ claude mcp add dumi-theme-antd-style \
-- python -m otcore.mcp_server <graph>