Skip to content

贡献指南&文章格式

作者 芒果

项目文档结构

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

  • Directorysrc
    • Directorycontent
      • Directorydocs
        • Directory前言
          • contribution-guide.mdx

文章格式

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


alt text

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

文章语法

项目启动

Terminal window
pnpm install
pnpm dev

即可在本地访问,push 分支前最好 build 一下,检查语法错误

Terminal window
pnpm build