当前位置:   article > 正文

vitepress使用教程

vitepress使用

itePress是Vue.js官方推出的基于Vite2构建的静态站点生成器。它旨在提供一个轻量、快速、易于使用的文档生成器,可以帮助开发人员快速搭建和发布文档网站。本篇文章将介绍VitePress的使用教程,并与VuePress进行比较。

安装VitePress

安装VitePress非常简单。只需全局安装VitePress,就可以在任何地方使用它:

npm install -g vitepress
  • 1

创建一个VitePress项目

创建一个VitePress项目也非常简单。只需创建一个新目录并初始化npm:

mkdir my-docs
cd my-docs
npm init -y
  • 1
  • 2
  • 3

然后,运行以下命令来初始化VitePress:

npx create-vitepress-site
  • 1

这会在当前目录下创建一个新的VitePress项目,并提示您选择一个默认主题和一个“docs”目录,其中包含您的文档。

编写文档

在“docs”目录下创建一个新文件夹,例如“guide”,然后创建一个名为“index.md”的新文件。这将是您的第一篇文档:

# Getting Started

Welcome to my documentation site powered by VitePress!

## Installation

First, you need to install VitePress. You can do this using npm:
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
npm install -g vitepress
npx create-vitepress-site
  • 1
  • 2

这会在当前目录下创建一个新的VitePress项目,并提示您选择一个默认主题和一个“docs”目录,其中包含您的文档。

运行VitePress

要启动VitePress本地开发服务器,请运行以下命令:npm run dev 然后,打开您的浏览器并访问http://localhost:3000,您将看到您的文档网站。

声明:本文内容由网友自发贡献,转载请注明出处:【wpsshop博客】
推荐阅读
相关标签
  

闽ICP备14008679号