PaperCard文档

主题

参与PaperCard文档的编写与维护 ​

技能要求 ​

  • 熟悉Markdown语法，官方教程

  • 熟悉Git和GitHub的使用

  • 熟悉vitepress框架，官方教程

  • 这些其实非常简单，很快能够学会

开发流程 ​

  • 要求您的电脑安装了NodeJS，如果未安装，可以去这里下载安装

  • Fork本仓库到您的GitHub账户，然后使用git clone xxx克隆到本地

  • 以下命令均需要工作目录为本项目根目录，请使用cd命令

  • 使用npm install命令安装本项目的依赖

  • 使用npm run docs:dev命令启动开发服务器，可以在本地打开网页

  • 添加或修改md文档

  • 使用npm run docs:build命令确保编译通过

  • 使用Git提交代码

  • 提交PullRequest

额外说明 ​

  • 推荐的文本编辑器：VSCode

  • 旧文档浏览地址为：https://docs.paper-card.cn， GitHub仓库地址为：https://github.com/pan90/docs， 旧文档同样使用Markdown语法，但使用的是GitBook， 主要工作就是迁移旧文档到新仓库，并移除过时的信息。

  • 感谢您的PaperCard的赞助与支持，参与文档编写将记为特殊赞助，展示在服务器官网赞助页面上

参考链接 ​

  1. Emoji大全 | Emoji表情符号词典 📓 | EmojiAll中文官方网站