-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
612 lines (438 loc) · 38.3 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=2">
<meta name="theme-color" content="#222">
<meta name="generator" content="Hexo 6.3.0">
<link rel="apple-touch-icon" sizes="180x180" href="/images/apple-touch-icon-next.png">
<link rel="icon" type="image/png" sizes="32x32" href="/images/favicon-32x32-next.png">
<link rel="icon" type="image/png" sizes="16x16" href="/images/favicon-16x16-next.png">
<link rel="mask-icon" href="/images/logo.svg" color="#222">
<link rel="stylesheet" href="/css/main.css">
<link rel="stylesheet" href="/lib/font-awesome/css/all.min.css">
<script id="hexo-configurations">
var NexT = window.NexT || {};
var CONFIG = {"hostname":"cleverpp.github.io","root":"/","scheme":"Pisces","version":"7.8.0","exturl":false,"sidebar":{"position":"left","display":"post","padding":18,"offset":12,"onmobile":false},"copycode":{"enable":false,"show_result":false,"style":null},"back2top":{"enable":true,"sidebar":false,"scrollpercent":false},"bookmark":{"enable":false,"color":"#222","save":"auto"},"fancybox":false,"mediumzoom":false,"lazyload":false,"pangu":false,"comments":{"style":"tabs","active":null,"storage":true,"lazyload":false,"nav":null},"algolia":{"hits":{"per_page":10},"labels":{"input_placeholder":"Search for Posts","hits_empty":"We didn't find any results for the search: ${query}","hits_stats":"${hits} results found in ${time} ms"}},"localsearch":{"enable":false,"trigger":"auto","top_n_per_article":1,"unescape":false,"preload":false},"motion":{"enable":true,"async":false,"transition":{"post_block":"fadeIn","post_header":"slideDownIn","post_body":"slideDownIn","coll_header":"slideLeftIn","sidebar":"slideUpIn"}}};
</script>
<meta name="description" content="前端技术，前端工程化，nodejs，Typescript，前端框架，前端可视化，Web3D，webVR/AR，web3.0，前端人工智能">
<meta property="og:type" content="website">
<meta property="og:title" content="cpzhang's frontend blog">
<meta property="og:url" content="https://cleverpp.github.io/index.html">
<meta property="og:site_name" content="cpzhang's frontend blog">
<meta property="og:description" content="前端技术，前端工程化，nodejs，Typescript，前端框架，前端可视化，Web3D，webVR/AR，web3.0，前端人工智能">
<meta property="og:locale" content="zh_CN">
<meta property="article:author" content="cpzhang">
<meta name="twitter:card" content="summary">
<link rel="canonical" href="https://cleverpp.github.io/">
<script id="page-configurations">
// https://hexo.io/docs/variables.html
CONFIG.page = {
sidebar: "",
isHome : true,
isPost : false,
lang : 'zh-CN'
};
</script>
<title>cpzhang's frontend blog</title>
<noscript>
<style>
.use-motion .brand,
.use-motion .menu-item,
.sidebar-inner,
.use-motion .post-block,
.use-motion .pagination,
.use-motion .comments,
.use-motion .post-header,
.use-motion .post-body,
.use-motion .collection-header { opacity: initial; }
.use-motion .site-title,
.use-motion .site-subtitle {
opacity: initial;
top: initial;
}
.use-motion .logo-line-before i { left: initial; }
.use-motion .logo-line-after i { right: initial; }
</style>
</noscript>
</head>
<body itemscope itemtype="http://schema.org/WebPage">
<div class="container use-motion">
<div class="headband"></div>
<header class="header" itemscope itemtype="http://schema.org/WPHeader">
<div class="header-inner"><div class="site-brand-container">
<div class="site-nav-toggle">
<div class="toggle" aria-label="切换导航栏">
<span class="toggle-line toggle-line-first"></span>
<span class="toggle-line toggle-line-middle"></span>
<span class="toggle-line toggle-line-last"></span>
</div>
</div>
<div class="site-meta">
<a href="/" class="brand" rel="start">
<span class="logo-line-before"><i></i></span>
<h1 class="site-title">cpzhang's frontend blog</h1>
<span class="logo-line-after"><i></i></span>
</a>
<p class="site-subtitle" itemprop="description">前端技术博客</p>
</div>
<div class="site-nav-right">
<div class="toggle popup-trigger">
</div>
</div>
</div>
<nav class="site-nav">
<ul id="menu" class="main-menu menu">
<li class="menu-item menu-item-home">
<a href="/" rel="section"><i class="fa fa-home fa-fw"></i>首页</a>
</li>
<li class="menu-item menu-item-archives">
<a href="/archives/" rel="section"><i class="fa fa-archive fa-fw"></i>归档</a>
</li>
</ul>
</nav>
</div>
</header>
<div class="back-to-top">
<i class="fa fa-arrow-up"></i>
<span>0%</span>
</div>
<main class="main">
<div class="main-inner">
<div class="content-wrap">
<div class="content index posts-expand">
<article itemscope itemtype="http://schema.org/Article" class="post-block" lang="zh-CN">
<link itemprop="mainEntityOfPage" href="https://cleverpp.github.io/2023/11/how-to-select-node-version/">
<span hidden itemprop="author" itemscope itemtype="http://schema.org/Person">
<meta itemprop="image" content="/images/avatar.png">
<meta itemprop="name" content="cpzhang">
<meta itemprop="description" content="前端技术，前端工程化，nodejs，Typescript，前端框架，前端可视化，Web3D，webVR/AR，web3.0，前端人工智能">
</span>
<span hidden itemprop="publisher" itemscope itemtype="http://schema.org/Organization">
<meta itemprop="name" content="cpzhang's frontend blog">
</span>
<header class="post-header">
<h2 class="post-title" itemprop="name headline">
<a href="/2023/11/how-to-select-node-version/" class="post-title-link" itemprop="url">how-to-select-node-version</a>
</h2>
<div class="post-meta">
<span class="post-meta-item">
<span class="post-meta-item-icon">
<i class="far fa-calendar"></i>
</span>
<span class="post-meta-item-text">发表于</span>
<time title="创建时间：2023-11-21 10:40:15" itemprop="dateCreated datePublished" datetime="2023-11-21T10:40:15+08:00">2023-11-21</time>
</span>
<span class="post-meta-item">
<span class="post-meta-item-icon">
<i class="far fa-calendar-check"></i>
</span>
<span class="post-meta-item-text">更新于</span>
<time title="修改时间：2023-11-23 10:17:54" itemprop="dateModified" datetime="2023-11-23T10:17:54+08:00">2023-11-23</time>
</span>
<span class="post-meta-item">
<span class="post-meta-item-icon">
<i class="far fa-folder"></i>
</span>
<span class="post-meta-item-text">分类于</span>
<span itemprop="about" itemscope itemtype="http://schema.org/Thing">
<a href="/categories/Node/" itemprop="url" rel="index"><span itemprop="name">Node</span></a>
</span>
</span>
</div>
</header>
<div class="post-body" itemprop="articleBody">
<h1 id="Node的版本选择"><a href="#Node的版本选择" class="headerlink" title="Node的版本选择"></a>Node的版本选择</h1><p>常常有小伙伴问我应该选择哪个Node版本，在回答这个问题之前，我们需要先知道：</p>
<ol>
<li>Node的版本规则</li>
<li>每个版本的ChangeLog，即该版本做了哪些变动</li>
<li>环境约束</li>
<li>项目约束</li>
</ol>
<p>掌握了以上4点，相信小伙伴们可以自己做出明智的选择！</p>
<h2 id="Node的版本规则"><a href="#Node的版本规则" class="headerlink" title="Node的版本规则"></a>Node的版本规则</h2><p>当我们进入Node官网时，看到的界面如下所示：</p>
<p><img src="https://vip.helloimg.com/images/2023/11/23/owyyVC.png" alt="Node官网界面"></p>
<p>有2个选择：LTS版和Current版。</p>
<ol>
<li>LTS版：LTS是Long-Term Support的缩写，即长期支持的版本。版本号为偶数，例如Node16、Node18、Node20等。<strong>重点在于稳定和安全，有至少30个月的维护期，随后进入EOL(结束阶段)不再维护。</strong> 通常在每年4月发布大版本。</li>
<li>Current版：即Node最新发布版本，包含最新特性和改进。版本号为奇数，例如Node17、Node19等。<strong>重点在于最新特性支持，更新频率更快。</strong> 通常每年10月发布大版本。</li>
</ol>
<p><strong>除非追求新特性或实验目的，无论是日常开发使用还是生产环境，均推荐选择已经进入活跃阶段或维护阶段的LTS版。</strong> 重点说明一下LTS版本的规律：通常情况下，4月发布，6个月后(同年10月份)成为LTS版，维护30个月后不再维护。重点关注以下2张表：(详细见参考链接2)</p>
<ol>
<li><p>版本规划表</p>
<p> <img src="https://vip.helloimg.com/images/2023/11/23/owyg6T.png" alt="node-release-schedule"></p>
</li>
<li><p>已经不再维护的版本表</p>
<p> <img src="https://vip.helloimg.com/images/2023/11/23/owyucS.png" alt="node-eol-releases"></p>
</li>
</ol>
<h2 id="版本ChangeLog"><a href="#版本ChangeLog" class="headerlink" title="版本ChangeLog"></a>版本ChangeLog</h2><p>两种方法查看版本ChangeLog，一种是官网news，另一种则是github中维护的Changelog[见参考链接3]，以下整理了从node12~node20的LTS版:</p>
<table>
<thead>
<tr>
<th align="left">版本</th>
<th align="left">LTS版</th>
<th align="left">环境要求</th>
<th align="left">特性</th>
</tr>
</thead>
<tbody><tr>
<td align="left">node12</td>
<td align="left">>=v12.13.0 LTS</td>
<td align="left">1. Windows(arm64) >= Windows 10 <br> 2. macOS(x64) >= 10.11 <br> 3. 更多查看<a target="_blank" rel="noopener" href="https://github.com/nodejs/node/blob/v12.x/BUILDING.md#platform-list">BUILDING.md</a></td>
<td align="left">1. V8引擎升级(7.2->7.4) <br> 2. 默认支持TLS1.3 <br> 3.更恰当的堆内存分配 <br> 4. 从http-parser迁移到llhttp <br> 5. 实验特性工作线程worker threads <br> 6. 实验特性诊断报告 <br> 7. 堆内存dump <br> 8. 启动速度改进 <br> 9. 实验特性ES6模块支持</td>
</tr>
<tr>
<td align="left">node14</td>
<td align="left">>=v14.15.0 LTS</td>
<td align="left">1. Windows(arm64) >= Windows 10 <br> 2. macOS(x64) >= 10.11 <br> 3. 更多查看<a target="_blank" rel="noopener" href="https://github.com/nodejs/node/blob/v14.x/BUILDING.md#platform-list">BUILDING.md</a></td>
<td align="left">1. V8升级到8.1，支持Optional Chaining（可选链）、Nullish Coalescing（空值合并）、Top-Level Await（顶级 await 支持）等功能 <br> 2. 实验特性Async Local Storage（异步本地存储）<br> 3. 实验性 Web Assembly 系统接口 <br> 4. Diagnostic report（诊断报告）变得稳定<br> 5. Stream</td>
</tr>
<tr>
<td align="left">node16</td>
<td align="left">>=v16.13.0 LTS</td>
<td align="left">1. Windows(arm64) >= Windows 10 <br> 2. macOS(x64) >= 10.13 <br> <strong>3. gcc >= 8.3</strong> <br> 4. 更多查看<a target="_blank" rel="noopener" href="https://github.com/nodejs/node/blob/v16.x/BUILDING.md#platform-list">BUILDING.md</a></td>
<td align="left">1. V8升级到9.0 <br> 2. 稳定Timers Promises API <br> 3. 实现试验性的标准Web加密API <br> 3. npm7 <br> 4. NODE-API version 8 <br> 5. 支持 btoa/atob 与浏览器环境保持了一致</td>
</tr>
<tr>
<td align="left">node18</td>
<td align="left">>=v18.12.0 LTS</td>
<td align="left">1. Windows(arm64) >= Windows 10 <br> 2. macOS(x64) >= 10.15 <br> <strong>3. gcc >=8.3</strong> <br> 4. 更多查看<a target="_blank" rel="noopener" href="https://github.com/nodejs/node/blob/v18.x/BUILDING.md#platform-list">BUILDING.md</a></td>
<td align="left">1. V8升级到10.1 <br> 2. 实验性Fetch API <br> 3. 实验性的test_runner,支持单元测试</td>
</tr>
<tr>
<td align="left">node20</td>
<td align="left">>=v20.9.0 LTS</td>
<td align="left">1. Windows(arm64) >= Windows 10 <br> 2. macOS(x64) >= 10.15 <br> <strong>3. gcc >= 10.1</strong> <br> 4. 更多查看<a target="_blank" rel="noopener" href="https://github.com/nodejs/node/blob/v20.x/BUILDING.md#platform-list">BUILDING.md</a></td>
<td align="left">1. V8升级到11.3 <br> 2. 实验性的权限模型 <br> 3. 稳定的test_runner <br> 4. 同步import.meta.reslove，与浏览器行为保持了一致 <br> 5. 构建可执行的独立包</td>
</tr>
</tbody></table>
<h2 id="环境约束"><a href="#环境约束" class="headerlink" title="环境约束"></a>环境约束</h2><p>在版本changelog章节中，列出了node12~node20的环境要求。值得注意的是，除了要关注自己本机的环境是否符合条件，请重点关注您项目生产构建发布的环境是否满足。</p>
<h2 id="项目约束"><a href="#项目约束" class="headerlink" title="项目约束"></a>项目约束</h2><p>所谓项目约束，是指您项目中的第三方依赖对node版本的要求，例如：</p>
<ol>
<li><p>显示的在package.json中标明：</p>
<figure class="highlight plaintext"><table><tr><td class="gutter"><pre><span class="line">1</span><br><span class="line">2</span><br><span class="line">3</span><br><span class="line">4</span><br></pre></td><td class="code"><pre><span class="line">// package.json</span><br><span class="line">"engines": {</span><br><span class="line"> "node": ">=16.13.0"</span><br><span class="line">},</span><br></pre></td></tr></table></figure>
<p> 如果您的node版本不符合条件则会<code>yarn install</code>失败，虽然您可以通过<code>yarn install --ignore-engines</code></p>
</li>
<li><p>还有些依赖虽然没有显示的说明对node版本的依赖，但是在低版本中使用或构建会报错，也需要通过升级到更新的node版本来解决。</p>
</li>
<li><p>像ESBuild、node-sass、node-gyp等依赖会根据node版本下载依赖的本地模块，如果无法安装也会导致项目安装失败(例如：内网环境)，<code>npm install --ignore-scripts</code> 可以解决在安装时无法下载本地模块的问题，但是会导致依赖无法正常使用，例如esbuild</p>
</li>
</ol>
<h1 id="总结"><a href="#总结" class="headerlink" title="总结"></a>总结</h1><p>Node版本的选择：</p>
<ol>
<li>选择LTS版，通常每年10月发布的偶数版本，例如：>=v20.9.0 、>=v18.12.0 、>= v16.13.0。</li>
<li>关注是否满足环境约束，查看目标版本的BUILDING.md</li>
<li>关注项目的第三方依赖的node版本的要求</li>
</ol>
<h1 id="参考"><a href="#参考" class="headerlink" title="参考"></a>参考</h1><p><a target="_blank" rel="noopener" href="https://nodejs.org/en/about/previous-releases">1. 官网release说明</a></p>
<p><a target="_blank" rel="noopener" href="https://github.com/nodejs/release#release-schedule">2. 在Github中维护的release-schedule</a></p>
<p><a target="_blank" rel="noopener" href="https://github.com/nodejs/node/tree/main/doc/changelogs">3. 在Github中维护的ChangeLog</a></p>
</div>
<footer class="post-footer">
<div class="post-eof"></div>
</footer>
</article>
<article itemscope itemtype="http://schema.org/Article" class="post-block" lang="zh-CN">
<link itemprop="mainEntityOfPage" href="https://cleverpp.github.io/2022/11/vitepress-1/">
<span hidden itemprop="author" itemscope itemtype="http://schema.org/Person">
<meta itemprop="image" content="/images/avatar.png">
<meta itemprop="name" content="cpzhang">
<meta itemprop="description" content="前端技术，前端工程化，nodejs，Typescript，前端框架，前端可视化，Web3D，webVR/AR，web3.0，前端人工智能">
</span>
<span hidden itemprop="publisher" itemscope itemtype="http://schema.org/Organization">
<meta itemprop="name" content="cpzhang's frontend blog">
</span>
<header class="post-header">
<h2 class="post-title" itemprop="name headline">
<a href="/2022/11/vitepress-1/" class="post-title-link" itemprop="url">vitepress-1</a>
</h2>
<div class="post-meta">
<span class="post-meta-item">
<span class="post-meta-item-icon">
<i class="far fa-calendar"></i>
</span>
<span class="post-meta-item-text">发表于</span>
<time title="创建时间：2022-11-15 11:22:19" itemprop="dateCreated datePublished" datetime="2022-11-15T11:22:19+08:00">2022-11-15</time>
</span>
<span class="post-meta-item">
<span class="post-meta-item-icon">
<i class="far fa-calendar-check"></i>
</span>
<span class="post-meta-item-text">更新于</span>
<time title="修改时间：2022-11-17 11:48:15" itemprop="dateModified" datetime="2022-11-17T11:48:15+08:00">2022-11-17</time>
</span>
<span class="post-meta-item">
<span class="post-meta-item-icon">
<i class="far fa-folder"></i>
</span>
<span class="post-meta-item-text">分类于</span>
<span itemprop="about" itemscope itemtype="http://schema.org/Thing">
<a href="/categories/SSG-Static-Site-Generation/" itemprop="url" rel="index"><span itemprop="name">SSG(Static Site Generation)</span></a>
</span>
</span>
</div>
</header>
<div class="post-body" itemprop="articleBody">
<h1 id="vitepress系列文章-1-使用vitepress搭建文档型网站"><a href="#vitepress系列文章-1-使用vitepress搭建文档型网站" class="headerlink" title="vitepress系列文章-1: 使用vitepress搭建文档型网站"></a>vitepress系列文章-1: 使用vitepress搭建文档型网站</h1><h2 id="vitepress是什么"><a href="#vitepress是什么" class="headerlink" title="vitepress是什么"></a>vitepress是什么</h2><blockquote><p>VitePress<br>Vite & Vue Powered Static Site Generator</p>
</blockquote>
<ul>
<li>基于Vue3和Vite的静态站点生成器</li>
<li>与VuePress(Vue2+webpack)功能类似</li>
<li>可以通过编写Markdown文档来生成网站，且允许Markdown中混合使用vue组件</li>
<li>官网链接: <a target="_blank" rel="noopener" href="https://vitepress.vuejs.org/">https://vitepress.vuejs.org/</a> </li>
<li>Github: <a target="_blank" rel="noopener" href="https://github.com/vuejs/vitepress">https://github.com/vuejs/vitepress</a></li>
</ul>
<h2 id="为什么选择vitepress"><a href="#为什么选择vitepress" class="headerlink" title="为什么选择vitepress"></a>为什么选择vitepress</h2><ul>
<li>Vue官方推荐</li>
<li>使用vite构建，速度快、热更行快</li>
<li>可以同时学习Vue3、Vite</li>
<li>比nuxtjs要轻量，配置简单，入门容易</li>
</ul>
<h2 id="vitepress适用场景"><a href="#vitepress适用场景" class="headerlink" title="vitepress适用场景"></a>vitepress适用场景</h2><ul>
<li>文档库</li>
<li>个人博客</li>
</ul>
<h2 id="如何使用vitepress"><a href="#如何使用vitepress" class="headerlink" title="如何使用vitepress"></a>如何使用vitepress</h2><h3 id="新建项目"><a href="#新建项目" class="headerlink" title="新建项目"></a>新建项目</h3><figure class="highlight plaintext"><table><tr><td class="gutter"><pre><span class="line">1</span><br><span class="line">2</span><br><span class="line">3</span><br><span class="line">4</span><br></pre></td><td class="code"><pre><span class="line">mkdir vitepress-starter && cd vitepress-starter</span><br><span class="line">yarn init // 或者 npm init</span><br><span class="line">yarn add --dev vitepress vue@3 typescript // npm install --save-dev vitepress vue typescript</span><br><span class="line">mkdir docs && echo '# Hello VitePress' > docs/index.md</span><br></pre></td></tr></table></figure>
<h3 id="运行环境配置"><a href="#运行环境配置" class="headerlink" title="运行环境配置"></a>运行环境配置</h3><ol>
<li>package.json</li>
</ol>
<figure class="highlight plaintext"><table><tr><td class="gutter"><pre><span class="line">1</span><br><span class="line">2</span><br><span class="line">3</span><br><span class="line">4</span><br><span class="line">5</span><br><span class="line">6</span><br><span class="line">7</span><br><span class="line">8</span><br><span class="line">9</span><br></pre></td><td class="code"><pre><span class="line">{</span><br><span class="line"> ...</span><br><span class="line"> "scripts": {</span><br><span class="line"> "docs:dev": "vitepress dev docs",</span><br><span class="line"> "docs:build": "vitepress build docs",</span><br><span class="line"> "docs:serve": "vitepress serve docs"</span><br><span class="line"> },</span><br><span class="line"> ...</span><br><span class="line">}</span><br></pre></td></tr></table></figure>
<h3 id="运行"><a href="#运行" class="headerlink" title="运行"></a>运行</h3><ol>
<li>开发模式(基于esbuild构建)</li>
</ol>
<figure class="highlight plaintext"><table><tr><td class="gutter"><pre><span class="line">1</span><br></pre></td><td class="code"><pre><span class="line">yarn docs:dev // 或 npm run docs:dev</span><br></pre></td></tr></table></figure>
<ol start="2">
<li>生产模式</li>
</ol>
<figure class="highlight plaintext"><table><tr><td class="gutter"><pre><span class="line">1</span><br><span class="line">2</span><br><span class="line">3</span><br><span class="line">4</span><br><span class="line">5</span><br></pre></td><td class="code"><pre><span class="line">// 构建生产包(基于rollup构建)</span><br><span class="line">yarn docs:build // 或 npm run docs:build</span><br><span class="line"></span><br><span class="line">// 起个本地服务运行看效果</span><br><span class="line">yarn docs:serve // 或 npm run docs:serve</span><br></pre></td></tr></table></figure>
<h3 id="进阶功能配置"><a href="#进阶功能配置" class="headerlink" title="进阶功能配置"></a>进阶功能配置</h3><ol>
<li>.vitepress/config.mts</li>
</ol>
<p>查看全部可配置内容，可通过TypeScript的类型声明UserConfig进行查阅, 以下是示例</p>
<figure class="highlight plaintext"><table><tr><td class="gutter"><pre><span class="line">1</span><br><span class="line">2</span><br><span class="line">3</span><br><span class="line">4</span><br><span class="line">5</span><br><span class="line">6</span><br><span class="line">7</span><br><span class="line">8</span><br><span class="line">9</span><br><span class="line">10</span><br><span class="line">11</span><br><span class="line">12</span><br><span class="line">13</span><br><span class="line">14</span><br><span class="line">15</span><br><span class="line">16</span><br><span class="line">17</span><br><span class="line">18</span><br><span class="line">19</span><br><span class="line">20</span><br><span class="line">21</span><br><span class="line">22</span><br><span class="line">23</span><br><span class="line">24</span><br><span class="line">25</span><br><span class="line">26</span><br><span class="line">27</span><br><span class="line">28</span><br><span class="line">29</span><br><span class="line">30</span><br><span class="line">31</span><br><span class="line">32</span><br><span class="line">33</span><br><span class="line">34</span><br><span class="line">35</span><br><span class="line">36</span><br><span class="line">37</span><br><span class="line">38</span><br><span class="line">39</span><br><span class="line">40</span><br><span class="line">41</span><br><span class="line">42</span><br><span class="line">43</span><br><span class="line">44</span><br><span class="line">45</span><br><span class="line">46</span><br><span class="line">47</span><br><span class="line">48</span><br><span class="line">49</span><br><span class="line">50</span><br><span class="line">51</span><br><span class="line">52</span><br><span class="line">53</span><br><span class="line">54</span><br><span class="line">55</span><br><span class="line">56</span><br><span class="line">57</span><br><span class="line">58</span><br><span class="line">59</span><br><span class="line">60</span><br><span class="line">61</span><br><span class="line">62</span><br><span class="line">63</span><br><span class="line">64</span><br><span class="line">65</span><br><span class="line">66</span><br><span class="line">67</span><br><span class="line">68</span><br><span class="line">69</span><br><span class="line">70</span><br><span class="line">71</span><br><span class="line">72</span><br><span class="line">73</span><br><span class="line">74</span><br><span class="line">75</span><br><span class="line">76</span><br></pre></td><td class="code"><pre><span class="line">import type { UserConfig, HeadConfig } from "vitepress";</span><br><span class="line"></span><br><span class="line">// 在html文档增加一些通用的脚本script、样式css、meta等</span><br><span class="line">const head: HeadConfig[] = [</span><br><span class="line"> [</span><br><span class="line"> "script",</span><br><span class="line"> {},</span><br><span class="line"> `;(() => {</span><br><span class="line"> console.log('script');</span><br><span class="line"> })()`,</span><br><span class="line"> ],</span><br><span class="line">];</span><br><span class="line"></span><br><span class="line">// 顶部导航配置</span><br><span class="line">const nav = [</span><br><span class="line"> { text: "基础组件", link: "/component/" },</span><br><span class="line"> { text: "高级组件", link: "/business/"},</span><br><span class="line"> { text: "可视化组件", link: "/visualization/" },</span><br><span class="line">];</span><br><span class="line"></span><br><span class="line">// 侧边导航配置</span><br><span class="line"></span><br><span class="line">const sidebar = {</span><br><span class="line"> '/component/': [</span><br><span class="line"> {</span><br><span class="line"> text: '开始',</span><br><span class="line"> collapsible: true,</span><br><span class="line"> items: [</span><br><span class="line"> {text:'如何使用', link: '/component/'},</span><br><span class="line"> ]</span><br><span class="line"> },</span><br><span class="line"> {</span><br><span class="line"> text:'通用',</span><br><span class="line"> collapsible: true,</span><br><span class="line"> items: [</span><br><span class="line"> {text:'Button 按钮', link:'/component/button'},</span><br><span class="line"> ],</span><br><span class="line"> },</span><br><span class="line"> ],</span><br><span class="line"> '/business/': [</span><br><span class="line"> {</span><br><span class="line"> text: '介绍',</span><br><span class="line"> collapsible: true,</span><br><span class="line"> items: [</span><br><span class="line"> {text:'如何使用',link: '/business/'},</span><br><span class="line"> ]</span><br><span class="line"> },</span><br><span class="line"> ],</span><br><span class="line"> '/visualization/': [</span><br><span class="line"> {</span><br><span class="line"> text: '介绍',</span><br><span class="line"> collapsible: true,</span><br><span class="line"> items: [</span><br><span class="line"> {text:'如何使用',link: '/visualization/'},</span><br><span class="line"> ]</span><br><span class="line"> },</span><br><span class="line"> ]</span><br><span class="line">}</span><br><span class="line"></span><br><span class="line"></span><br><span class="line">const config: UserConfig = {</span><br><span class="line"> title: "文档库",</span><br><span class="line"> description: "此处是描述",</span><br><span class="line"> lang: 'zh-CN',</span><br><span class="line"> lastUpdated: true,</span><br><span class="line"> ignoreDeadLinks: true,</span><br><span class="line"> base: "",</span><br><span class="line"> head,</span><br><span class="line"> themeConfig: {</span><br><span class="line"> nav,</span><br><span class="line"> sidebar,</span><br><span class="line"> smoothScroll: true,</span><br><span class="line"> },</span><br><span class="line">};</span><br><span class="line"></span><br><span class="line">export default config;</span><br></pre></td></tr></table></figure>
<ol start="2">
<li>主题配置</li>
</ol>
<figure class="highlight plaintext"><table><tr><td class="gutter"><pre><span class="line">1</span><br><span class="line">2</span><br><span class="line">3</span><br><span class="line">4</span><br><span class="line">5</span><br><span class="line">6</span><br><span class="line">7</span><br><span class="line">8</span><br><span class="line">9</span><br><span class="line">10</span><br><span class="line">11</span><br><span class="line">12</span><br><span class="line">13</span><br><span class="line">14</span><br><span class="line">15</span><br><span class="line">16</span><br><span class="line">17</span><br></pre></td><td class="code"><pre><span class="line">// .vitepress/theme/index.ts</span><br><span class="line"></span><br><span class="line">import DefaultTheme from 'vitepress/theme'</span><br><span class="line">import './style.css' // 此处是主题的全局样式，可覆盖原主题的设置</span><br><span class="line">import type { Theme } from 'vitepress'</span><br><span class="line"></span><br><span class="line">const define = <T>(value: T): T => value</span><br><span class="line">export default define<Theme>({</span><br><span class="line"> ...DefaultTheme, // 此处采用了默认主题，可以替换为自定义的主题</span><br><span class="line"> NotFound: DefaultTheme.NotFound,</span><br><span class="line"> enhanceApp: ({ app, router, siteData }) => {</span><br><span class="line"> app.use('xxx'); // 一些组件或库，来增加功能</span><br><span class="line"> console.log(router);</span><br><span class="line"> console.log(siteData)</span><br><span class="line"> },</span><br><span class="line">})</span><br><span class="line"></span><br></pre></td></tr></table></figure>
<ol start="3">
<li>首页自定义 [index.md]</li>
</ol>
<p>布局选择home，包含 hero 和 features 两部分</p>
<figure class="highlight plaintext"><table><tr><td class="gutter"><pre><span class="line">1</span><br><span class="line">2</span><br><span class="line">3</span><br><span class="line">4</span><br><span class="line">5</span><br><span class="line">6</span><br><span class="line">7</span><br><span class="line">8</span><br><span class="line">9</span><br><span class="line">10</span><br><span class="line">11</span><br><span class="line">12</span><br><span class="line">13</span><br><span class="line">14</span><br><span class="line">15</span><br><span class="line">16</span><br><span class="line">17</span><br><span class="line">18</span><br><span class="line">19</span><br><span class="line">20</span><br><span class="line">21</span><br><span class="line">22</span><br><span class="line">23</span><br><span class="line">24</span><br><span class="line">25</span><br><span class="line">26</span><br><span class="line">27</span><br><span class="line">28</span><br><span class="line">29</span><br><span class="line">30</span><br><span class="line">31</span><br><span class="line">32</span><br><span class="line">33</span><br></pre></td><td class="code"><pre><span class="line">---</span><br><span class="line">layout: home</span><br><span class="line"></span><br><span class="line">hero:</span><br><span class="line"> name: VitePress</span><br><span class="line"> text: Vite & Vue powered static site generator.</span><br><span class="line"> tagline: Lorem ipsum...</span><br><span class="line"> image:</span><br><span class="line"> src: /logo.png</span><br><span class="line"> alt: VitePress</span><br><span class="line"> actions:</span><br><span class="line"> - theme: brand</span><br><span class="line"> text: Get Started</span><br><span class="line"> link: /component/index</span><br><span class="line"> - theme: alt</span><br><span class="line"> text: View on GitHub</span><br><span class="line"> link: https://github.com/vuejs/vitepress</span><br><span class="line"> - theme: alt</span><br><span class="line"> text: 测试按钮</span><br><span class="line"> link: /business/index</span><br><span class="line"></span><br><span class="line">features:</span><br><span class="line"> - icon: ⚡️</span><br><span class="line"> title: Vite, The DX that can't be beat</span><br><span class="line"> details: Lorem ipsum...</span><br><span class="line"> - icon: 🖖</span><br><span class="line"> title: Power of Vue meets Markdown</span><br><span class="line"> details: Lorem ipsum...</span><br><span class="line"> - icon: 🛠️</span><br><span class="line"> title: Simple and minimal, always</span><br><span class="line"> details: Lorem ipsum...</span><br><span class="line">---</span><br><span class="line"></span><br></pre></td></tr></table></figure>
<h3 id="运行效果"><a href="#运行效果" class="headerlink" title="运行效果"></a>运行效果</h3><ul>
<li><p>首页效果<br><img src="https://s1.ax1x.com/2022/11/17/ze2B59.png" alt="首页" title="首页"></p>
</li>
<li><p>其中的一个文档页<br><img src="https://s1.ax1x.com/2022/11/16/zZT0Tf.png" alt="Button页" title="Button页"></p>
</li>
</ul>
<h2 id="总结"><a href="#总结" class="headerlink" title="总结"></a>总结</h2><ul>
<li>整体来说开发体验很快，配置也简单</li>
<li>下一篇文章预告：vitepress系列文章-2: 如何开发并应用自定义的vitepress主题</li>
</ul>
</div>
<footer class="post-footer">
<div class="post-eof"></div>
</footer>
</article>
</div>
<script>
window.addEventListener('tabs:register', () => {
let { activeClass } = CONFIG.comments;
if (CONFIG.comments.storage) {
activeClass = localStorage.getItem('comments_active') || activeClass;
}
if (activeClass) {
let activeTab = document.querySelector(`a[href="#comment-${activeClass}"]`);
if (activeTab) {
activeTab.click();
}
}
});
if (CONFIG.comments.storage) {
window.addEventListener('tabs:click', event => {
if (!event.target.matches('.tabs-comment .tab-content .tab-pane')) return;
let commentClass = event.target.classList[1];
localStorage.setItem('comments_active', commentClass);
});
}
</script>
</div>
<div class="toggle sidebar-toggle">
<span class="toggle-line toggle-line-first"></span>
<span class="toggle-line toggle-line-middle"></span>
<span class="toggle-line toggle-line-last"></span>
</div>
<aside class="sidebar">
<div class="sidebar-inner">
<ul class="sidebar-nav motion-element">
<li class="sidebar-nav-toc">
文章目录
</li>
<li class="sidebar-nav-overview">
站点概览
</li>
</ul>
<!--noindex-->
<div class="post-toc-wrap sidebar-panel">
</div>
<!--/noindex-->
<div class="site-overview-wrap sidebar-panel">
<div class="site-author motion-element" itemprop="author" itemscope itemtype="http://schema.org/Person">
<img class="site-author-image" itemprop="image" alt="cpzhang"
src="/images/avatar.png">
<p class="site-author-name" itemprop="name">cpzhang</p>
<div class="site-description" itemprop="description">前端技术，前端工程化，nodejs，Typescript，前端框架，前端可视化，Web3D，webVR/AR，web3.0，前端人工智能</div>
</div>
<div class="site-state-wrap motion-element">
<nav class="site-state">
<div class="site-state-item site-state-posts">
<a href="/archives/">
<span class="site-state-item-count">2</span>
<span class="site-state-item-name">日志</span>
</a>
</div>
<div class="site-state-item site-state-categories">
<span class="site-state-item-count">2</span>
<span class="site-state-item-name">分类</span>
</div>
</nav>
</div>
<div class="links-of-author motion-element">
<span class="links-of-author-item">
<a href="https://github.com/cleverpp" title="GitHub → https://github.com/cleverpp" rel="noopener" target="_blank"><i class="fab fa-github fa-fw"></i>GitHub</a>
</span>
<span class="links-of-author-item">
<a href="https://www.zhihu.com/people/clever-zhang" title="知乎 → https://www.zhihu.com/people/clever-zhang" rel="noopener" target="_blank"><i class="fab fa-zhihu fa-fw"></i>知乎</a>
</span>
</div>
</div>
</div>
</aside>
<div id="sidebar-dimmer"></div>
</div>
</main>
<footer class="footer">
<div class="footer-inner">
<div class="copyright">
©
<span itemprop="copyrightYear">2023</span>
<span class="with-love">
<i class="fa fa-heart"></i>
</span>
<span class="author" itemprop="copyrightHolder">cpzhang</span>
</div>
<div class="powered-by">由 <a href="https://hexo.io/" class="theme-link" rel="noopener" target="_blank">Hexo</a> & <a href="https://pisces.theme-next.org/" class="theme-link" rel="noopener" target="_blank">NexT.Pisces</a> 强力驱动
</div>
</div>
</footer>
</div>
<script src="/lib/anime.min.js"></script>
<script src="/lib/velocity/velocity.min.js"></script>
<script src="/lib/velocity/velocity.ui.min.js"></script>
<script src="/js/utils.js"></script>
<script src="/js/motion.js"></script>
<script src="/js/schemes/pisces.js"></script>
<script src="/js/next-boot.js"></script>
</body>
</html>