《Vite 基础知识》Vitepress 技术文档站点搭建与配置

前言

简介

VitePress 是一个静态站点生成器 (SSG),专为构建快速、以内容为中心的站点而设计。

简而言之,可构建你自己的 技术文档站点

环境要求

Node.js 18 及以上版本。我使用 v20.11.0

创建

第一步: 全局安装

npm i vitepress -g

第二步: 在项目目录下执行 安装向导

npx vitepress init

根据提示完成如下配置指导,注意代码 16 行,没有使用 Typescript

┌  Welcome to VitePress!
│
◇  Where should VitePress initialize the config?
│  ./docs
│
◇  Site title:
│  My Awesome Project
│
◇  Site description:
│  A VitePress Site
│
◇  Theme:
│  Default Theme
│
◇  Use TypeScript for config and theme files?
│  No
│
◇  Add VitePress npm scripts to package.json?
│  Yes
│
└  Done! Now run npm run docs:dev and start writing.

如图

在这里插入图片描述

此时的文档目录如下

.
├─ docs
|   ├─ .vitepress            
|   |  └─ config.mjs		 # 配置文件
|   ├─ api-examples.md       # markdown 文件 
|   ├─ markdown-examples.md	 # markdown 文件 
|   └─ index.md				 # markdown 文件 
└─ package.json	             # 插件依赖

第三步:package.json 中加上依赖插件 vitepress。如下代码第 2-4 行

注意 版本号是 1.0.0-rc.40,现在最新版 1.0.0-rc.44报错 No matching version found for perfect-debounce@^1.0.0.

{
    "devDependencies": {
        "vitepress": "1.0.0-rc.40"
    },
    "scripts": {
        "docs:dev": "vitepress dev docs",
        "docs:build": "vitepress build docs",
        "docs:preview": "vitepress preview docs"
    }
}

第四步: 安装依赖

npm i

第五步: 启动系统

npm run docs:dev

启动效果如下,默认地址 http://localhost:5173:

在这里插入图片描述

配置

配置文件 docs/.vitepress/config.mjc

站点配置

站点配置是全局设置。本文仅列出我常用的,想了解更多请参考 官网之站点配置。

title

站点的标题

export default defineConfig({
    title: "我的前端技术站点",
})

description

站点的描述,可在 HTML 中的 <meta> 标签中查看

export default defineConfig({
    description: "我的前端技术站点",
})

lang

站点的语言属性,默认是 en-US英文。设置为 zh-Hans 中文简体。

export default defineConfig({
    lang: 'zh-Hans',
})

base

部署路径,默认是 /。注意目录结构必须以 / 开头和结尾。

// 建议定义为常量,后续功能需要
const base = '/myroute/';

export default defineConfig({
    base,
})

在这里插入图片描述

head

可在 HTML <head> 标签添加其它元素,如图标、css 文件静态资源等。

  • 官网默认将静态资源放在 public 目录 下,但需要新建目录 ./docs/public
  • 如果有设置 base 属性,则注意 head 中的静态资源路径也要加上 ,如代码7,8 行;
// 建议定义为常量,后续功能需要
const base = '/mypath/';

export default defineConfig({
    base,
    head: [
        ['link', { rel: 'icon', href: `${base}logo.png` }],
        ['link', { rel: 'stylesheet', href: `${base}css/index.css` }],
    ],
})

在这里插入图片描述

主题配置

此篇仅介绍 默认主题 的配置,想了解更多请参考 官网之默认主题。

导航栏

显示在页面顶部的导航栏,注意都在属性 themeConfig 下。包含:

  • logo 站点图标;
  • siteTile 站点标题;
  • nav 导航链接;
  • socialLinks 社交链接;

PS:我以前狭隘了,使用 vuepress 时,一直理解仅 nav 属性是导航栏…

在这里插入图片描述

export default defineConfig({
    themeConfig: {
        siteTitle: 'My Custom Title',   // 站点标题
        logo: '/logo.png',			    // 站点图标
        nav: [							// 导航链接
            { text: 'Home', link: '/' },
            { text: 'Examples', link: '/markdown-examples' }
        ],
        socialLinks: [					// 社交链接
            { icon: 'github', link: 'https://github.com/vuejs/vitepress' }
        ]
    }
})

侧边栏

侧边栏是文档的主要导航块。可以在 themeConfig.sidebar 中配置侧边栏菜单。

  • .md文件从目录 ./docs/ 下开始;
  • 便于统一管理.md文件,可放在同一目录,例如新建目录 ./docs/guide/
  • 但首页文件 index.md 还是放在 ./docs/ 下;
  • 属性 sidebar ,基本用法是 数组类型,多侧边栏是对象类型;
export default defineConfig({
    themeConfig: {
        sidebar: [{
            text: 'Examples',
            items: [
                { text: 'Markdown Examples', link: '/guide/markdown-examples' },
                { text: 'Runtime API Examples', link: '/guide/api-examples' }
            ]
        }],
    }
})

在这里插入图片描述

其它

outline.label

右侧渲染大纲标题设置,默认是 On this page ,自定义配置如下:

export default defineConfig({
    themeConfig: {
        outline: {
            label: '页面导航'
        },
    }
})

在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:/a/415112.html

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

图搜索基础-深度优先搜索

图搜索基础-深度优先搜索 参考原理引入流程解析手推例子 代码实现运行结果结果分析 参考 理论参考&#xff1a;深蓝学院 实现参考&#xff1a;github项目 原理 引入 对于这样一个图&#xff0c;我们试图找到S到G的通路&#xff1a; 计算机程序不会像人眼一样&#xff0c;一…

鸿蒙应用程序包安装和卸载流程

开发者 开发者可以通过调试命令进行应用的安装和卸载&#xff0c;可参考多HAP的调试流程。 图1 应用程序包安装和卸载流程&#xff08;开发者&#xff09; 多HAP的开发调试与发布部署流程 多HAP的开发调试与发布部署流程如下图所示。 图1 多HAP的开发调试与发布部署流程 …

线性DP-前缀和

哪种连续子字符串更长 思路 我们遍历输入字符串s中的每个字符。对于每个字符&#xff0c;我们检查它是1还是0&#xff0c;并相应地更新currentLength1和currentLength0。当我们遇到一个1时&#xff0c;我们增加currentLength1的值&#xff0c;并将currentLength0重置为0&#…

2023秋季飞书未来无限大会--随笔

这个时代的飞书 数字时代 工作协同平台 AI时代 帮助企业和个人用好AI 企业如何引用大模型能力&#xff1f; 智慧体— 接近人&#xff0c;有进步空间智能伙伴 用时代的科技打造爱不释手的好产品 移动互联网 – 改变信息分发方式 大模型 –自然的人机交互方式 业务协同 …

Swagger接口文档管理工具

Swagger 1、Swagger1.1 swagger介绍1.2 项目集成swagger流程1.3 项目集成swagger 2、knife4j2.1 knife4j介绍2.2 项目集成knife4j 1、Swagger 1.1 swagger介绍 官网&#xff1a;https://swagger.io/ Swagger 是一个规范和完整的Web API框架&#xff0c;用于生成、描述、调用和…

kali linux通过aircrack-ng命令破解wifi密码

相关阅读&#xff1a;如何破解攻击WiFi 百度安全验证https://baijiahao.baidu.com/s?id1764248756021219497&wfrspider&forpc上面2篇文章写得都很不错 一、前期准备工作 1、将无线网卡挂载到Kali上 ​ 将无线网卡插到电脑上&#xff0c;如果弹出检测到新的USB设备&…

break,continue

break&#xff1a;跳出并结束循环 continue:跳过本次循环&#xff0c;执行下一次循环 代码演示&#xff1a; package com.zhang.loop;public class BreakAndContinueDemo8 {public static void main(String[] args) {//掌握break和continue的作用//1. break&#xff1a;跳出循…

​LeetCode解法汇总2673. 使二叉树所有路径值相等的最小代价

目录链接&#xff1a; 力扣编程题-解法汇总_分享记录-CSDN博客 GitHub同步刷题项目&#xff1a; https://github.com/September26/java-algorithms 原题链接&#xff1a;. - 力扣&#xff08;LeetCode&#xff09; 描述&#xff1a; 给你一个整数 n 表示一棵 满二叉树 里面节…

Java设计模式 | 七大原则之迪米特法则

基本介绍 一个对象应该对其他对象保持最少的了解类与类关系越密切&#xff0c;耦合度越大迪米特法则&#xff08;Demeter Principle&#xff09;又叫最少知道法则&#xff0c;即一个类对自己依赖的类知道的越少越好。也就是说&#xff0c;对于被依赖的类不管多么复杂&#xff…

虚拟机 VMware 安装 Windows2000 (iso 光盘镜像)

上篇博客关于 kali 的安装&#xff0c;我们下载的直接是 vmx 文件 这次我们以 iso 文件为例&#xff0c;因此配置过程会有些许不同 先在本地新建一个文件夹用于存放我们一会儿下载的 iso 镜像文件 下载好后是一个后缀为 .iso 的文件 同样我们先打开 VMware 依次点击文件 -&g…

亚信安慧AntDB开启超融合数据库新纪元

&#xff08;一&#xff09; 前言 据统计&#xff0c;在信息化时代的今天&#xff0c;人们一天所接触到的信息量&#xff0c;是古人一辈子所能接收到的信息量的总和。当今社会中除了信息量“多”以外&#xff0c;人们对信息处理的“效率”和“速度”的要求也越来越高。譬如&…

lv21 QT对话框3

1 内置对话框 标准对话框样式 内置对话框基类 QColorDialog, QErrorMessage QFileDialog QFontDialog QInputDialog QMessageBox QProgressDialogQDialog Class帮助文档 示例&#xff1a;各按钮激发对话框实现基类提供的各效果 第一步&#xff1a;实现组件布局&…

C语言标准库函数qsort( )——数据排序

大家好&#xff01;我是保护小周ღ&#xff0c;本期为大家带来的是深度解剖C语言标准库函数 qsort()&#xff0c;qsort()函数他可以对任意类型的数据排序&#xff0c;博主会详细解释函数使用方法&#xff0c;以及使用快速排序的左右指针法模拟实现函数功能&#xff0c;这样的排…

本科毕业设计:计及并网依赖性的分布式能源系统优化研究。(C语言实现)(内包含NSGA II优化算法)(一)

目录 前言 1、分布式能源系统模型介绍 2、运行策略 前言 本篇文章介绍的是我的毕业设计&#xff0c;我将C语言将其实现。 1、分布式能源系统模型介绍 这是我将研究的分布式能源系统的框架&#xff0c;内部供能装置包括&#xff1a;太阳能光伏板&#xff1b;sofc燃料电池、太阳…

【数据结构】周末作业

1.new(struct list_head*)malloc(sizeof(struct list_head*)); if(newNULL) { printf("失败\n"); return; } new->nextprev->next; prev->nextnew; return; 2.struct list_head* pprev->next; prev->nextp->next; p->next->prevpr…

设计模式----装饰器模式

在软件开发过程中&#xff0c;有时想用一些现存的组件。这些组件可能只是完成了一些核心功能。但在不改变其结构的情况下&#xff0c;可以动态地扩展其功能。所有这些都可以釆用装饰器模式来实现。 装饰器模式 允许向一个现有的对象添加新的功能&#xff0c;同时又不改变他的…

python_可视化_交互_多条线段点击高亮显示

需求 使用matplotlib 绘制折线图 响应鼠标事件 单击折线 线条高亮显示 解决方法: 使用 mplcursors 库, 一句代码可实现. 代码 import matplotlib.pyplot as plt import mplcursors import numpy as np# 生成一些示例数据 x np.linspace(0, 10, 100) y np.sin(x)# 创建绘图…

Linux的gdb调试

文章目录 一、编译有调试信息的目标文件二、启动gdb调试文件1、查看内容list/l&#xff1a;l 文件名:行号/函数名&#xff0c;l 行号/函数名2、打断点b&#xff1a;b文件名:行号/函数名&#xff0c;b 行号/函数名 与 查看断点info/i&#xff1a;info b3、删除断点d&#xff1a;…

基于InternLM和LangChain搭建自己的知识库

背景 LLM存在一定的局限性&#xff0c;如&#xff1a; 知识时效性受限&#xff1a;如何让LLM能够获取最新的知识专业能力有限&#xff1a;如何打造垂直领域的大模型定制化成本高&#xff1a;如何打造个人专属的LLM应用 正文 为了突破LLM的局限性&#xff0c;目前有两种范式…

Python入门学习:if语句与条件控制--and、or、in、not in详解与实践

Python入门学习&#xff1a;if语句与条件控制–and、or、in、not in详解与实践 &#x1f308; 个人主页&#xff1a;高斯小哥 &#x1f525; 高质量专栏&#xff1a;Matplotlib之旅&#xff1a;零基础精通数据可视化、Python基础【高质量合集】、PyTorch零基础入门教程&#x1…