Skip to content

VitePress

本站说明

本站是采用VitePress搭建的日常笔记系统,VitePress是一个强大的静态网站生成器,官网为 https://vitepress.dev/ ,有以下几个特点:

  • 简单
  • 强大
  • 快速

开始Demo

  1. 新建一个文件夹 note-v2

  2. 安装vitepress

    shell
    npm add -D vitepress
  3. 初始化项目

    shell
    npx vitepress init
    
    #T  Welcome to VitePress!
    #|
    #o  Where should VitePress initialize the config?
    #|  ./docs
    #|
    #o  Site title:
    #|  My Awesome Project
    #|
    #o  Site description:
    #|  A VitePress Site
    #|
    #o  Theme:
    #|  Default Theme
    #|
    #o  Use TypeScript for config and theme files?
    #|  No
    #|
    #o  Add VitePress npm scripts to package.json?
    #|  Yes
    #|
    #—  Done! Now run npm run docs:dev and start writing.
  4. 文档目录结构

    .
    ├─ docs                     # 根目录
    │  ├─ .vitepress    
    │  │  └─ config.js          # 核心配置文件
    │  ├─ api-examples.md       # 示例文档1
    │  ├─ markdown-examples.md  # 示例文档2
    │  └─ index.md              # 主页 
    └─ package.json
  5. 开始使用

    npm run docs:dev