Skip to content

贡献指南&文章格式

作者 芒果

项目文档结构

  • 文件路由:docs 目录下的文件名对应网站路由 url

  • Directorysrc
    • Directorycontent
      • Directorydocs
        • Directory指南
          • contribution-guide.mdx

文章格式

md mdx 文件里必须有要有下列格式,title 是必填项,对应了侧边栏文章的显示名称,description 是可选的,为了 seo 优化


alt text

---
title: 贡献指南
description: 贡献指南
---

文章语法

项目启动

  1. 安装必要的开发环境

    • 安装 Node.js
    • 安装 pnpm
  2. 安装项目依赖并启动开发服务器

    Terminal window
    pnpm install
    pnpm dev

    执行完上述命令后即可在本地启动项目

  3. 构建项目

    Terminal window
    pnpm build

    此命令会检查项目语法错误并生成生产环境代码