【教程】使用vitepress搭配githubPages构建自己的在线笔记

1. 创建VitePress项目

确保自己已经安装好了node,我这个笔记用的是node 18.16.0,
怎么安装nvm这个可以csdn或者掘金,再或者等我有空了我就更新一下

  1. 使用nvm安装node
# 查看可用版本
nvm list avaliable
# 安装node
nvm install 18.16.0
# 切换node
nvm use 18.16.0 
  1. 创建vitepress项目
# 首先全局安装vitepress
npm install -D vitepress 
# 创建一个项目文件夹
mkdir notes
cd notes
# 使用vitepress自带的npx初始化
npx vitepress init
  1. 配置vitepress
┌  Welcome to VitePress!
│
◇  Where should VitePress initialize the config?
│  ./docs
│
◇  Site title:
│  notes(你的项目名称)
│
◇  Site description:
│  后端仔的笔记(你的项目介绍)
│
◇  Theme:
│  Default Theme
│
◇  Use TypeScript for config and theme files?
│  Yes
│
◇  Add VitePress npm scripts to package.json?
│  Yes
│
└  Done! Now run npm run docs:dev and start writing.
  1. 运行
npm run docs:dev

2. 推送项目到github

  1. 在GitHub创建一个项目
  2. 给当前文件夹配置远程仓库
# 在项目的根目录初始化git
git init
# 添加远程仓库地址
git remote add origin git@github.com:youname/notes.git
  1. 在项目根目录创建.gitignore文件
/node_modules/
/.idea/
  1. 提交代码到远程仓库
# 检查文件状态
git status
# 添加文件被git管理
git add *
# 提交
git commit -m 初始化提交
# 推送远程
git push origin

3. 创建github部署脚本

最终要在GitHub的Pages展示的所以创建一个部署脚本,参考十分钟使用vitepress+github action+gitee pages 搭建你的专属文档

  1. 在项目根目录创建 .github/workflows文件夹,然后在这个文件夹下创建deploy.yml
    因为我不需要gitee的Pages所以下边的配置就被我删除了

name: Deploy VitePress site to Pageson:push:# 推送任意tags或者master分支推送的时候触发任务tags:- '*'branches:- masterworkflow_dispatch:jobs:deploy-and-sync:runs-on: ubuntu-lateststeps:- name: Checkout 🛎️uses: actions/checkout@v4with:ref: 'master'- name: Install yarnrun: corepack enable- uses: actions/setup-node@v3with:node-version: '18'cache: 'yarn'- name: Install dependenciesrun: yarn install- name: Build Siterun: npm run docs:build# 将文档产物提交到gh-pages分支- name: Deploy for Github 🚀uses: JamesIves/github-pages-deploy-action@v4.4.1with:branch: gh-pagesfolder: docs/.vitepress/dist# enable single-commit to reduce the repo sizesingle-commit: trueclean: true#      - name: Sync to Gitee
#        uses: wearerequired/git-mirror-action@v1.2.0
#        env:
#          SSH_PRIVATE_KEY: ${{ secrets.GITEE_RSA_PRIVATE_KEY }}
#        with:
#          # GitHub 仓库地址
#          source-repo: git@github.com:chargeduck/notes.git
#          # Gitee 仓库地址
#          destination-repo: git@gitee.com:chargeduck/notes.git
#
#      - name: Build Gitee Pages
#        uses: yanglbme/gitee-pages-action@main
#        with:
#          # 替换为你的 Gitee 用户名
#          gitee-username: chargeduck
#          # 注意在 Settings->Secrets 配置 GITEE_PASSWORD
#          gitee-password: ${{ secrets.GITEE_PASSWORD }}
#          # 注意替换为你的 Gitee 仓库,仓库名严格区分大小写,请准确填写,否则会出错
#          gitee-repo: chargeduck/notes
#          # 要部署的分支,默认是 master,若是其他分支,则需要指定(指定的分支必须存在)
#          branch: gh-pages
  1. 按照上边的步骤把这个文件提交到github上

4. Pages配置

  1. 打开github的仓库地址,找到Settings,选择Pages
  2. 在右侧的 Build and deployment下边的Source选择Deploy form a branch
  3. 在下边的Branch中选择gh-pages分支 /(root)默认然后保存即可

5. 遇到的问题

1. 提交之后没有生成gh-pages分支

第一次是因为 deploy.yml没有放到.github/workflow文件夹下

2. 工作流执行错误记录

修改了deploy.yml位置正确后还是没有创建gh-pages分支
点击仓库的Actions选项,在页面上的All Workflows中找到失败的job

1. Dependencies lock file is not found in /home/runner/work/notes/notes. Supported file patterns: yarn.lock

deploy.yml中执行了yarn来打包和管理依赖,但是项目里边没有yarn.lock文件

  1. 执行命令
yarn install

这个时候我的node版本还是16.0.0,他报错vite@5.0.10: The engine "node" is incompatible with this module. Expected version "^18.0.0 || >=20.0.0". Got "16.20.0"
再执行

nvm list available
nvm install 18.16.0
nvm use 18.16.0
# 再次执行项目出现 yarn.lock 
yarn install
# 把yarn.lock提交到github上

2. The deploy step encountered an error: The process ‘/usr/bin/git’ failed with exit code 128

提示我没有权限,按照上边csdn老哥的步骤。

在 GitHub 项目的Settings -> Actions -> General路径下配置Fork pull request workflows from outside collaboratorsRequire approval for first-time contributors who are new to GitHub

Workflow permissions配置为Read and write permissions

3.本地正常上传到github上之后没有样式

config.mts中忘记添加base

export default defineConfig({// 这个要和自己的仓库地址一致base: '/notes/',
})

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

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Parallels Desktop 19完美中文版 PD19虚拟机详细图文安装教程 亲测兼容M1/M2

对于许多Mac用户来说,运行Windows应用程序是必不可少的。也许你的雇主使用的软件只适用于Windows,或者需要使用依赖于某些Windows技术的网站。或者你想在Mac上玩Windows游戏。或者,你可能需要在其他操作系统上测试应用程序和服务——你可以在…

免 Administrator 权限安装软件

以欧路词典为例, 从官网下载的安装包 https://www.eudic.net/v4/en/app/download 直接运行会弹出 UAC 提示需要管理员权限. 一个词典而已, 为啥要管理员权限呢? 答案是安装程序默认使用的安装路径是 C:\Program Files\ 这就不难理解了. 对于这种不需要其他额外权限的软件, 可以…

使用OpenCV计算滑块缺口

1.参考文章:https://blog.csdn.net/qq_27371025/article/details/133072065 2.实现过程:接口中传入base64 图片,base64转化为image ,通过图片获取缺口信息 实现步骤: 2.1 安装:cv2 opencv-python 是 OpenCV&#xff08…

陪甲方吃饭3万不眨眼,升级自己B端界面花3000,感觉肉疼。

这种情况其实贝格前端工场是经常碰到的,不仅在我们这个行业,在所有行业都存在,这种现象也好解释,中间原因,贝格给大家解读一下。 中国是个人情和熟人社会,做生意讲求托关系,找熟人,…

HSB矩形调色板设计和计算方法

HSB矩形调色板设计和计算方法 RGB调色板绘制较容易,HSB调色板较难绘制,前些天发文介绍了几个矩形样例的绘制方法,今介绍矩形的HSB调色板的设计方法和H,S,B值的计算方法,好东西必须与大家分享。 此文介绍HSB调色板和选色条的绘制方…

主流的目标检测算法是那种?

目前,主流的目标检测算法主要分为两大类:基于区域建议的双阶段目标检测算法和基于回归分析的单阶段目标检测算法。 1. 基于区域建议的双阶段目标检测算法:这类算法通常包括 R-CNN、SPP-Net、Fast R-CNN、Faster R-CNN、FPN、Mask R-CNN 等。…

Topaz Photo AI 3.0.0 (macOS Universal) - AI 图片修复工具

Topaz Photo AI 3.0.0 (macOS Universal) - AI 图片修复工具 Maximize Image Quality with AI 请访问原文链接:Topaz Photo AI 3.0.0 (macOS Universal) - AI 图片修复工具,查看最新版。原创作品,转载请保留出处。 作者主页:sy…

【黑马头条】-day12项目部署和发布-jenkins

文章目录 1 持续集成2 软件开发模式2.1 瀑布模式2.2 敏捷开发2.2.1 迭代开发2.2.2 增量开发 3 Jenkins3.1 Jenkins安装3.1.1 导入镜像3.1.2 配置3.1.3 初始化设置 3.2 插件安装3.3 服务器环境准备3.3.1 Docker安装配置3.3.2 Git安装配置3.3.3 Maven安装配置 3.4 Jenkins工具配置…

【SAP ME 19】SAP ME创建开发组件(DC)dbscripts

目录 1、说明 2、创建开发组件 3、相关性 4、公共部分 5、引入CBS队列 1、

如何在PostgreSQL中对表进行重命名或修改表结构,以及这可能带来的潜在风险和解决方案

文章目录 一、对表进行重命名潜在风险及解决方案 二、修改表结构潜在风险及解决方案 PostgreSQL是一个强大的开源关系型数据库管理系统,它提供了丰富的SQL命令来管理数据库、表、视图等对象。其中,重命名表或修改表结构是常见的操作。但是,这…

在matplotlib中控制colorbar的长度

在matplotlib中控制colorbar的长度 使用matplotlib绘制带颜色的箭头图,有时想直接把颜色条拿来当比例尺条,就需要控制颜色条的长度。 1. pyplot.colorbar()参数说明 pyplot.colorbar(mappable, ax, cax, **kwargs) mappable是一个ScalarMappble类型的…

【精简改造版】大型多人在线游戏BrowserQuest服务器Golang框架解析(2)——服务端架构

1.架构选型 B/S架构:支持PC、平板、手机等多个平台 2.技术选型 (1)客户端web技术: HTML5 Canvas:支持基于2D平铺的图形引擎 Web workers:允许在不减慢主页UI的情况下初始化大型世界地图。 localStorag…

同旺科技 USB TO SPI / I2C适配器读写24LC256--字节写

所需设备: 1、USB 转 SPI I2C 适配器;内附链接 2、24LC256芯片 适应于同旺科技 USB TO SPI / I2C适配器升级版、专业版; 00地址写入一个字节数据AA,并读回验证; 单字节写时序: 读字节时序: …

MTK6775/MT6775/曦力P70联发科处理器性能参数资料

联发科MT6775(曦力P70)芯片搭载强大的Arm Cortex-A73/A53八核CPU,并采用台积电12纳米FinFET制程工艺,相较于其他14纳米级别产品,功耗节省达到了15%。此外,曦力P70还配备了高效能的Arm Mali-G72 GPU,相比上一代产品曦力…

C++ | Leetcode C++题解之第43题字符串相乘

题目&#xff1a; 题解&#xff1a; class Solution { public:string multiply(string num1, string num2) {if (num1 "0" || num2 "0") {return "0";}int m num1.size(), n num2.size();auto ansArr vector<int>(m n);for (int i …

算法——BFS算法

1. 什么是BFS算法 BFS&#xff08;广度优先搜索&#xff0c;Breadth-First Search&#xff09;算法是一种用于图和树等数据结构中进行搜索的基本算法。它从指定的起始节点开始&#xff0c;逐层地向外扩展搜索&#xff0c;直到找到目标节点或遍历完整个图。 BFS算法的基本思想是…

idea连接远程服务器并同步代码

idea连接远程服务器并同步代码 打开我们的idea。 tool -> deployment -> configuration 新建连接 -> sftp host输入你的远程服务器ip&#xff0c;输入用户名、密码、测试连接 连接成功 选择服务器根目录 web链接&#xff08;无需要不用&#xff09; 点击mappin…

启动前端项目

前提&#xff1a; node.js vue 查找是否下载好&#xff1a; node -v 检查版本 npm -v 检查版本先下载依赖&#xff1a; npm install 启动&#xff1a; npm run serve/dev 依赖下载失败解决方案&#xff1a; 一、在项目根路径找到.npmc文件把镜像路径改成…

如何在Spring中巧妙应用工厂模式实现解耦

一、工厂模式 工厂模式通过定义一个用于创建对象的接口&#xff0c;让子类决定实例化哪一个类。该模式的目的是使系统在不明确指定对象具体类型的情况下&#xff0c;通过调用工厂方法来创建对象。在Java中&#xff0c;工厂模式可以帮助我们封装对象的创建逻辑&#xff0c;使得…

【学习笔记二十一】EWM仓库两步拣配配置及操作展示

一、EWM两步拣配配置 1.定义两步拣配的WPT ①第一步:标准WPT2020,目标仓位是2010两步拣配的仓位,并创建存储类型2010的两步拣配的仓位 ②第二步,标准WPT2010,目标仓位9020发货区和发货的仓位 2.定义确定仓库处理类型的控制标识 3.确定仓库处理类型 4.仓库编码级别需要允…