VitePress-01-从零开始的项目创建(npm版)

这篇具有很好参考价值的文章主要介绍了VitePress-01-从零开始的项目创建(npm版)。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

说明

本文介绍一下 VitePress的项目创建的步骤。
主要用到的命令工具是 npm
本文的操作步骤是从无到有的创建一个完整的基本的【VitePress】项目。

环境准备

根据官方文档的介绍,截止本文发稿时,需要使用node.js 18+ 的版本。
可以使用node -v 的命令查看版本。
如果不满足要求的,可以安装一下后再进行本文的继续阅读。

VitePress-01-从零开始的项目创建(npm版),VitePress,VitePress,创建项目

创建一个目录作为项目目录

mkdir vitepressProject01

进入目录,安装 vitepress 依赖

cd vitepressProject01
npm install vitepress --save-dev

安装完成后 项目中会生成 package.json 文件,
因为我们是空目录下直接执行的 npm install 命令,所以,该文件的内容也是非常的简单,如下:

{
  "devDependencies": {
    "vitepress": "^1.0.0-rc.36"
  }
}

执行安装向导(核心)

这个步骤是本文的重点,
主要用到的 vitepress命令来引导我们创建项目,填写一些项目的必要信息。
执行完成后 会 自动生成基本的项目结构与项目中的文档。

执行命令

# 本命令是为了确保后面的命令在项目目录下执行
cd vitepressProject01
# 核心命令,执行完此命令之后开始了正式创建项目的过程
npx vitepress init

过程记录

这个过程,主要是根据引导填写一些信息,从而完善项目的基本信息。

┌  Welcome to VitePress! # 开始创建
│
◇  Where should VitePress initialize the config?  # 指定项目配置文件的目录,【./】 表示项目的根目录
│  ./
│
◇  Site title: # 指定项目的名称
│  创建项目案例
│
◇  Site description: # 指定项目的描述
│  对VitePress项目创建的简单测试
│
◇  Theme: # 选择项目的主题
│  Default Theme
│
◇  Use TypeScript for config and theme files? # 选择时候使用ts进行配置
│  Yes
│
◇  Add VitePress npm scripts to package.json? # 选择是否自动添加相关的脚本到 package.json 文件中
│  Yes
│
└  Done! Now run npm run docs:dev and start writing. # 完成创建

执行结果

package.json 文件中添加了启动脚本

  "scripts": {
    "docs:dev": "vitepress dev",
    "docs:build": "vitepress build",
    "docs:preview": "vitepress preview"
  }

自动生成相关的文件,项目目录结构成型

vitepressProject01
├── .vitepress 				# 项目相关的配置文件,都放在这个目录下
│   └── config.mts 			# 本项目的配置文件,ts 的
├── api-examples.md 		# 自动生成的一个文档文件
├── index.md 				# 项目的入口文件
├── markdown-examples.md 	# 自动生成的一个文档文件
├── node_modules 			# 需要用到的依赖
├── package-lock.json
└── package.json 			# 脚本配置文件

【 补充1 】
默认情况下,VitePress 将其开发服务器缓存存储在 .vitepress/cache 中,并将生产构建输出存储在 .vitepress/dist 中。
如果使用 Git,应该将它们添加到 .gitignore 文件中。也可以手动配置这些位置。

【 补充2 】
【.vitepress】 目录中存放的是项目的配置相关的内容;
项目中其他的【.md】文件,都是项目的源文件,会被编译成 【.html】文件在浏览器中进行访问。

本文暂不对文件的具体内容做分析,只是了解基本的项目结构即可。

启动并访问项目

启动命令

根据的是在 package.json 中的脚本进行启动

npm run docs:dev

VitePress-01-从零开始的项目创建(npm版),VitePress,VitePress,创建项目

访问项目

VitePress-01-从零开始的项目创建(npm版),VitePress,VitePress,创建项目

至此,vitepress 项目的基本的创建就完成了!文章来源地址https://www.toymoban.com/news/detail-808181.html

到了这里,关于VitePress-01-从零开始的项目创建(npm版)的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 从零开始创建一个vue3+vite项目并集成element-plus、eslint以及prettier

    项目git地址, 欢迎修改提交,不足地方还请补充批评指正! 项目git地址 ESLint 是一个用于识别和报告在 ECMAScript/JavaScript 代码中发现的模式的工具,其目标是使代码更加一致并避免错误。 ESLint 是完全插件化的。每条规则都是一个插件,你可以在运行时添加更多。你还可以添

    2024年04月09日
    浏览(77)
  • 从零开始制作一个基于STM32和ESP8266-01S的智能时钟(3)ESP8266-01S模块(上)

    提示:这里可以添加本文要记录的大概内容:之前在忙着,现在继续补充完整,然后这次的ESP-01S的典型应用图是没有连接RST引脚的,但是我的项目是用到了RST引脚的,所以需要使用跳线连接一下RST引脚。 本项目需要基础的stm32单片机知识,这里我推荐 链接:https://www.bilibil

    2024年02月03日
    浏览(53)
  • 如何从零开始创建React应用:简易指南

    🌟 前言 欢迎来到我的技术小宇宙!🌌 这里不仅是我记录技术点滴的后花园,也是我分享学习心得和项目经验的乐园。📚 无论你是技术小白还是资深大牛,这里总有一些内容能触动你的好奇心。🔍 🤖 洛可可白 :个人主页 🔥 个人专栏 :✅前端技术 ✅后端技术 🏠 个人

    2024年04月22日
    浏览(73)
  • Hbuilder+uniapp 从零开始创建一个小程序

    当你看到这篇博客的时候,那~说明~我的这篇博客写完了……哈哈哈哈哈哈哈哈。好的,清耐心往下看哈。如果有需要的,可以关注一下小作,后面还有小程序的云开发嗷~ 为什么要申请一个小程序账号? 哈哈哈哈,你如果有这个疑问的话,那你很棒棒嗷~我第一次看到官方网

    2024年02月09日
    浏览(49)
  • C# SolidWorks 二次开发 -从零开始创建一个插件(2)

    上一篇我详细讲解了如何创建一个插件,但是无界面无按钮,这种插件适合配合事件偷偷的在后台做点什么事情。今天这篇讲一下如何增加一些按钮到工具栏、菜单上去。 先告诉大家这个东西注册表在哪,因为solidworks在这方面做的不太好,插件你改个名字,就有多个工具栏

    2024年02月15日
    浏览(60)
  • Observability:从零开始创建 Java 微服务并监控它 (一)

    在本教程中,你将学习如何使用 Elastic 可观察性监控 Java 应用程序:日志、基础设施指标、APM 和正常运行时间。通过本教程,你将学到: 创建示例 Java 应用程序。 使用 Filebeat 提取日志并在 Kibana 中查看你的日志。 使用 Metricbeat Prometheus 模块获取指标并在 Kibana 中查看你的指

    2023年04月08日
    浏览(33)
  • 【云计算 | OpenStack】从零开始使用libvirt创建一个kvm虚机

    环境: os镜像:CentOS-7-x86_64-Minimal-2009.iso qemu-kvm:qemu-kvm.x86_64 10:1.5.3-175.el7_9.6 Libvirt:libvirt-4.5.0-36.el7.x86_64 基于内核的虚拟机 KVM (Kernel-Based Virtual Machine) 需要两个条件:硬件支持全虚拟化、操作系统为Linux。KVM只支持对虚拟机的虚拟CPU、虚拟内存进行管理和调度;针对其他的虚

    2024年02月02日
    浏览(46)
  • 记录自己从零开始创建个人小程序到发布的大致过程

    首先不管是要创建个人小程序还是公众号等,都要打开微信公众平台。本文以微信小程序为例,创建一个手工花名片。本文只用于自己学习记录。参考微信社区 1、打开微信公众,点击注册 链接:https://mp.weixin.qq.com/ 2、点击注册后,跳转页面,点击小程序 3、填写注册小程序

    2024年02月12日
    浏览(53)
  • Vue项目搭建(从零开始)

    前言:笔者于明年六七月份毕业,现在正在准备毕设,该文章就是准备毕设项目的前端心路 在开始文章之前首先说明本人的前端水平,大概就是 写过一些原生的前端表格,了解vue,对它的一些组件和功能听说过,基本属于啥也不会状态,这也预示着vue的学习路程不会太过轻

    2024年02月09日
    浏览(48)
  • 从项目开始学习Vue——01

    https://cn.vuejs.org/ 参考:如何创建Vue项目 node 安装教程 如果报 不是命令 :那么需要配环境变量 。 npm run serve 启动服务后,ctr + c 停止服务 。 创建过程可能出现错误 错误1.(可能选错了vue-cli) ERR! code EPERM 。 npm ERR! syscall open 。 错误2. 说明(没给权限) npm ERR! code EPERM 。 np

    2024年02月06日
    浏览(41)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包