dumi-theme-lobehub 1.4.0 → 1.4.1

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.
package/README.md CHANGED
@@ -32,7 +32,9 @@ dumi-theme-lobehub is a documentation site theme package designed for `Dumi 2`.
32
32
 
33
33
  #### TOC
34
34
 
35
+ - [✨ Features](#-features)
35
36
  - [📦 Installation](#-installation)
37
+ - [🤯 Usage](#-usage)
36
38
  - [⌨️ Local Development](#️-local-development)
37
39
  - [🤝 Contributing](#-contributing)
38
40
 
@@ -40,11 +42,14 @@ dumi-theme-lobehub is a documentation site theme package designed for `Dumi 2`.
40
42
 
41
43
  </details>
42
44
 
43
- ## 📦 Installation
45
+ ## Features
44
46
 
45
- ```bash
46
- pnpm add dumi-theme-antd-style -D
47
- ```
47
+ - [x] 🤯 **Modern Theme Style:** This theme package adopts modern design techniques such as gradient colors, frosted glass, lighting effects, and natural animations to present the interface in a more concise and visually appealing way, making the documents more intuitive, readable, and user-friendly.
48
+ - [x] 🌓 **One-click Switch between Light and Dark Theme Mode:** Based on antd v5, custom algorithms for light and dark themes are provided by default, offering aesthetically pleasing and user-friendly options. Users can choose the theme mode according to their preferences and enjoy a good reading experience in different lighting environments.
49
+ - [x] 💅 **Based on Ant Design and CSSinJS:** This theme package uses antd as the base component library and implements the style solution using CSSinJS, which helps to better control the style details and improve style reusability and maintainability. The underlying antd-style library provides more flexibility, readability, and ease of maintenance in writing styles.
50
+ - [x] 🪄 **Exquisite Syntax Highlighting:** This theme package provides accurate and beautiful syntax highlighting. It utilizes modern syntax highlighting libraries like Shiki and Prism, and offers a rich set of code highlighting schemes to enhance code readability.
51
+ - [x] 🧩 **Flexible Component Reusability:** This theme package provides high flexibility for customizing local themes. It exports premium components from the theme package, which can be reused as independent modules. Developers can freely combine and use these components in the dumi local theme package.
52
+ - [x] 📱 **Well-Adapted for Mobile Devices:** This theme package is well-adapted for mobile devices. With the flexible style solution based on CSSinJS, multiple layout options are easily implemented. Users can enjoy a consistent and smooth experience across different devices.
48
53
 
49
54
  <div align="right">
50
55
 
@@ -52,22 +57,23 @@ pnpm add dumi-theme-antd-style -D
52
57
 
53
58
  </div>
54
59
 
55
- ## ⌨️ Local Development
56
-
57
- You can use Gitpod for online development:
58
-
59
- [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][gitpod-url]
60
+ ## 📦 Installation
60
61
 
61
- Or clone it for local development:
62
+ Quick Start Installation It is recommended to use `pnpm` for installation:
62
63
 
63
64
  ```bash
64
- $ git clone https://github.com/lobehub/dumi-theme-lobehub.git
65
- $ cd dumi-theme-lobehub
66
- $ pnpm install
67
- $ pnpm start
65
+ pnpm add dumi-theme-antd-style -D
68
66
  ```
69
67
 
70
- Theme Config:
68
+ <div align="right">
69
+
70
+ [![][back-to-top]](#readme-top)
71
+
72
+ </div>
73
+
74
+ ## 🤯 Usage
75
+
76
+ Usage After installation, start the site with `dumi`, and the theme will be automatically loaded for use.
71
77
 
72
78
  ```ts
73
79
  interface SiteThemeConfig {
@@ -96,6 +102,29 @@ interface SiteThemeConfig {
96
102
  }
97
103
  ```
98
104
 
105
+ > 👉 Tip: For detailed configuration, please refer to the [Type file](https://github.com/lobehub/dumi-theme-lobehub/blob/master/src/types/config.ts) | [Example](https://github.com/lobehub/dumi-theme-lobehub/blob/master/example/.dumirc.ts).
106
+
107
+ <div align="right">
108
+
109
+ [![][back-to-top]](#readme-top)
110
+
111
+ </div>
112
+
113
+ ## ⌨️ Local Development
114
+
115
+ You can use Gitpod for online development:
116
+
117
+ [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][gitpod-url]
118
+
119
+ Or clone it for local development:
120
+
121
+ ```bash
122
+ $ git clone https://github.com/lobehub/dumi-theme-lobehub.git
123
+ $ cd dumi-theme-lobehub
124
+ $ pnpm install
125
+ $ pnpm start
126
+ ```
127
+
99
128
  <div align="right">
100
129
 
101
130
  [![][back-to-top]](#readme-top)
@@ -106,11 +135,14 @@ interface SiteThemeConfig {
106
135
 
107
136
  <!-- CONTRIBUTION GROUP -->
108
137
 
109
- > 📊 Total: <kbd>**1**</kbd>
138
+ > 📊 Total: <kbd>**2**</kbd>
110
139
 
111
140
  <a href="https://github.com/canisminor1990" title="canisminor1990">
112
141
  <img src="https://avatars.githubusercontent.com/u/17870709?v=4" width="50" />
113
142
  </a>
143
+ <a href="https://github.com/actions-user" title="actions-user">
144
+ <img src="https://avatars.githubusercontent.com/u/65916846?v=4" width="50" />
145
+ </a>
114
146
 
115
147
  <!-- CONTRIBUTION END -->
116
148
 
@@ -6,9 +6,9 @@ function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefine
6
6
  function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
7
7
  import { ActionIcon, TabsNav } from '@lobehub/ui';
8
8
  import { openCodeSandbox, openStackBlitz, useIntl } from 'dumi';
9
- import SourceCode from 'dumi/theme-default/builtins/SourceCode';
10
9
  import { Code, Code2, Codesandbox, MonitorUp, Zap } from 'lucide-react';
11
10
  import { useState } from 'react';
11
+ import SourceCode from "../../builtins/SourceCode";
12
12
  import { useStyles } from "./style";
13
13
  import { jsx as _jsx } from "react/jsx-runtime";
14
14
  import { jsxs as _jsxs } from "react/jsx-runtime";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "dumi-theme-lobehub",
3
- "version": "1.4.0",
3
+ "version": "1.4.1",
4
4
  "description": "dumi-theme-lobehub is a documentation site theme package designed for dumi2. It provides a more beautiful and user-friendly development and reading experience based on @lobehub/ui",
5
5
  "keywords": [
6
6
  "lobehub",