上传新文档流程

1. 流程简介

   • 基于Markdown的Wiki系统，本质是由一系列Markdown文件组成的Git工程
   • Markdown是一种标记语言，它可以使普通文本内容具有一定的格式。Markdown文件扩展名为md，且兼容Html、支持代码高亮，很容易由Markdown文件生成网页文档
   • 需要将新文档写成Markdown格式，在home.md目录文件中添加对应关系，然后提交本Git工程即可
   • 【上传过一次文档，走一遍完整流程，即可上手】

2. Markdown文本编辑器

   • 使用Markdown只需要记住几个简单语法，即可书写流畅的网页文档。不用关注排版、表格生成、链接跳转的具体实现。（实际上Markdown本身并不简单，高级语法可以直接书写数学公式、甘特图等复杂结构（需要对应的解析库支持））。可以参考下面两个样例，写上几个“#” “|” “-”就可以生成已经排好版的网页文档

   • Markdown文件“源码”样例（实际书写格式）

     

   • Markdown文件网页样例（网页展示格式）

     

   • 使用Markdown文本编辑器，书写流畅且能进一步降低学习成本。支持Markdown的文本编辑器很多，比如Notepad++、Visual Studio、Visual Studio Code，甚至印象笔记

     部分Markdown编辑器参考

   • 推荐使用Typora

     Typora本身轻量、快速、简单、所见即所得，且语法提示功能强大，用鼠标右键选择格式就好，连语法都不用学啦……

     

     Typora本地下载地址(粘贴到地址栏按回车)

     \\192.168.1.21\public\windows\typora-setup-x64.exe

     其他下载地址(官网)

3. Markdown语法简介

   了解更多的语法格式，可以进一步了解文件组织方式、实现高级及其他自定义功能等

   少数派Markdown快速入门

   Runboob Markdown教程

4. 新文档书写及上传

   4.1 在根目录创建新文档的Markdown文件，比如“sdk-channel-android.md”

   4.2 按Markdown语法书写文档，如果有图片等资源文件，放到根目录asset文件夹中对应的目录

   4.3 在根目录的home.md添加对应的关系。比如sdk-channel-android.md属于客户端的SDK部分，需要在对应的地方填写路径信息

   

   4.4 检查无误后提交本Git工程，去对应的网页链接检查有无排版错误，然后找对应上级审查

   4.5 有问题的话，修改Markdown文件，重新提交即可