Skip to content

Commit a1217c4

Browse files
authored
Merge pull request #40 from devlive-community/feature-dev
支持多个扩展
2 parents eb5f1a3 + b12bf5c commit a1217c4

File tree

13 files changed

+457
-160
lines changed

13 files changed

+457
-160
lines changed

docs/content/getting-started/create-site/index.en.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ icon: folder-plus
1111
pageforge init
1212
```
1313

14+
!!! warning "注意"
15+
16+
如果使用的是 init 命令,即使后面指定了文件夹目录,也不会创建文件夹,只会在当前目录下初始化。
17+
18+
!!!
19+
1420
或者
1521

1622
```bash

docs/content/getting-started/create-site/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ icon: folder-plus
1111
pageforge init
1212
```
1313

14+
!!! warning "注意"
15+
16+
如果使用的是 init 命令,即使后面指定了文件夹目录,也不会创建文件夹,只会在当前目录下初始化。
17+
18+
!!!
19+
1420
或者
1521

1622
```bash

docs/content/usage/grid.md

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
---
2+
title: Grid
3+
icon: grid
4+
---
5+
6+
PageForge 支持网格布局语法。
7+
8+
!!! danger "注意"
9+
10+
该功能需要在配置文件中启用,可以在 `pageforge.yaml` 中配置 `feature.grid.enable: true`
11+
12+
!!!
13+
14+
## 基本语法
15+
16+
---
17+
18+
- 源代码
19+
20+
```markdown
21+
::: grid
22+
- 第一个网格项
23+
- 第二个网格项
24+
- 第三个网格项
25+
- 第四个网格项
26+
:::
27+
```
28+
29+
- 显示效果
30+
31+
::: grid
32+
- 第一个网格项
33+
- 第二个网格项
34+
- 第三个网格项
35+
- 第四个网格项
36+
:::
37+
38+
## 设置列数
39+
40+
---
41+
42+
- 源代码
43+
44+
```markdown
45+
::: grid cols-3
46+
- 第一列内容
47+
- 第二列内容
48+
- 第三列内容
49+
- 第四列内容(自动换行)
50+
- 第五列内容
51+
- 第六列内容
52+
:::
53+
```
54+
55+
- 显示效果
56+
57+
::: grid cols-3
58+
- 第一列内容
59+
- 第二列内容
60+
- 第三列内容
61+
- 第四列内容(自动换行)
62+
- 第五列内容
63+
- 第六列内容
64+
:::
65+
66+
## 设置间距
67+
68+
---
69+
70+
- 源代码
71+
72+
```markdown
73+
::: grid cols-2 gap-8
74+
- 这是第一个网格项
75+
可以包含多行内容
76+
- 这是第二个网格项
77+
间距设置为 8 (2rem)
78+
- 这是第三个网格项
79+
- 这是第四个网格项
80+
:::
81+
```
82+
83+
- 显示效果
84+
85+
::: grid cols-2 gap-8
86+
- 这是第一个网格项
87+
可以包含多行内容
88+
- 这是第二个网格项
89+
间距设置为 8 (2rem)
90+
- 这是第三个网格项
91+
- 这是第四个网格项
92+
:::
93+
94+
## 禁用响应式
95+
96+
---
97+
98+
默认情况下,网格布局是响应式的:
99+
- 移动设备:1列
100+
- 平板设备:最多2列
101+
- 桌面设备:完整列数
102+
103+
使用 `no-responsive` 可以禁用响应式布局:
104+
105+
```markdown
106+
::: grid cols-4 no-responsive
107+
- 第一列
108+
- 第二列
109+
- 第三列
110+
- 第四列
111+
:::
112+
```
113+
114+
## 完整选项
115+
116+
---
117+
118+
网格布局支持以下选项:
119+
120+
1. `cols-{number}`: 设置列数(默认:2)
121+
- 例如:`cols-3``cols-4``cols-6`
122+
123+
2. `gap-{number}`: 设置网格间距(默认:4)
124+
- 例如:`gap-4``gap-6``gap-8`
125+
126+
3. `no-responsive`: 禁用响应式布局
127+
- 默认启用响应式
128+
129+
可以组合使用这些选项:
130+
131+
```markdown
132+
::: grid cols-3 gap-6 no-responsive
133+
- 内容1
134+
- 内容2
135+
- 内容3
136+
:::
137+
```
138+
139+
## 实际应用示例
140+
141+
---
142+
143+
创建特色卡片布局:
144+
145+
```markdown
146+
::: grid cols-3 gap-6
147+
- ### 🚀 快速上手
148+
零配置,开箱即用,
149+
支持 Markdown 所有基础语法。
150+
151+
- ### 📦 功能丰富
152+
内置大量扩展组件,
153+
支持自定义扩展。
154+
155+
- ### 🎨 主题系统
156+
提供多套主题,
157+
支持自定义主题。
158+
:::
159+
```
160+
161+
::: grid cols-3 gap-6
162+
- ### 🚀 快速上手
163+
零配置,开箱即用,
164+
支持 Markdown 所有基础语法。
165+
166+
- ### 📦 功能丰富
167+
内置大量扩展组件,
168+
支持自定义扩展。
169+
170+
- ### 🎨 主题系统
171+
提供多套主题,
172+
支持自定义主题。
173+
174+
```java
175+
console.log(1)
176+
```
177+
:::

docs/content/usage/tab.md

Lines changed: 33 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -3,50 +3,55 @@ title: 选项卡
33
icon: pill
44
---
55

6-
PageForge 支持使用 markdown 实现了选项卡相关信息。
6+
PageForge 支持使用 Markdown 实现了选项卡相关信息。
7+
8+
!!! danger "注意"
9+
10+
该功能需要在配置文件中启用,可以在 `pageforge.yaml` 中配置 `feature.tabs.enable: true`
11+
12+
!!!
713

814
### 基本语法
915

1016
---
1117

1218
```markdown
1319
::: tabs
14-
1520
=== "Tab 1"
16-
这是第一个 Tab 的内容
17-
支持多行内容
18-
19-
=== "Tab 2"
21+
这是第一个标签页的内容
22+
可以包含多行内容
2023

21-
这是第二个 Tab 的内容
22-
也支持 **Markdown** 语法
23-
24+
也可以包含 Markdown 格式
25+
- 列表项 1
26+
- 列表项 2
27+
28+
=== "Tab 2"
29+
这是第二个标签页的内容
30+
2431
=== "Tab 3"
25-
26-
第三个 Tab 的内容
27-
28-
- 支持列表
29-
- 支持其他 Markdown 内容
30-
32+
第三个标签页的内容
3133
:::
3234
```
3335

3436
::: tabs
35-
3637
=== "Tab 1"
37-
这是第一个 Tab 的内容
38-
支持多行内容
39-
这是 `dd` 哈哈
38+
这是第一个标签页的内容
39+
可以包含多行内容
4040

41+
也可以包含 Markdown 格式
42+
- 列表项 1
43+
- 列表项 2
44+
4145
=== "Tab 2"
42-
这是第二个 Tab 的内容
43-
44-
也支持 **Markdown** 语法
45-
46+
这是第二个标签页的内容
47+
48+
### 可以使用标题
49+
50+
```javascript
51+
// 甚至可以包含代码块
52+
const x = 1;
53+
```
54+
4655
=== "Tab 3"
47-
第三个 Tab 的内容
48-
49-
- 支持列表
50-
- 支持其他 **Markdown** 内容
51-
56+
第三个标签页的内容
5257
:::

docs/pageforge.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,10 @@ feature:
9191
</script>
9292
search:
9393
enable: true
94+
tabs:
95+
enable: true
96+
grid:
97+
enable: true
9498

9599
i18n:
96100
default: zh-CN
@@ -189,6 +193,7 @@ nav:
189193
- /usage/diff
190194
- /usage/button
191195
- /usage/icon
196+
- /usage/grid
192197
- Template:
193198
- /template/home
194199
- /template/team

lib/extension/marked/pageforge-code-block.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ require('prismjs/components/prism-powershell');
4040
// Config & markup
4141
require('prismjs/components/prism-docker');
4242
require('prismjs/components/prism-nginx');
43+
require('prismjs/components/prism-properties')
4344

4445
const PageForgeCodeBlockExtension = {
4546
name: 'pageforgeCodeBlock',

0 commit comments

Comments
 (0)