基于mdwiki使用Markdown实现的wiki

写在前面

MSDK做了这么久,被开发商嗤之以鼻最多的问题之一就是文档。问题的原因比较多,主要是三个方面:

  1. MSDK没有完整的线上文档,所有的文档都是跟随版本包。
  2. MSDK同时外发版本太多
  3. MSDK的版本文档使用word编写,不同版本文档不易比对。

由于以上的问题,经常出现游戏更新版本以后没有同步使用新版本的文档,无法同步更新我们已经修正的文档错误,或者由于文档比对太过麻烦和版本太多,开发修改文档错误以后比较难同步修改到其余版本。

为了解决这个问题,MSDK团队早期尝试过使用wiki,然而由于wiki的语法太过复杂,编辑的时间成本很高,所以最终还是没能坚持。但是文档online化总要解决,不然上面的问题会一直存在。为了让伟大的开发哥哥们不受困于wiki,最后在github终于找到了神器。mdwiki一个基于bootstrap的,使用markdown编辑内容的js wiki框架。

源码地址:

https://github.com/bihe0832/MSDK-wiki/

目录结构

  • android:Android Wiki相关文档
    • navigation.md:Android Wiki 菜单配置文件
    • config.json:Android Wiki 风格配置
    • *.md:Android 各模块文档
    • *.jpg:Android 文档中用到的图片
  • CSS:wiki页面相关的css
  • font:wiki页面使用到的特殊字体
  • ios:IOS Wiki相关文档
    • navigation.md:IOS Wiki 菜单配置文件
    • config.json:IOS Wiki 风格配置
    • *.md:IOS 各模块文档
    • *.jpg:IOS 文档中用到的图片
  • js:wiki页面相关的js
  • router:Router Wiki相关文档
    • navigation.md:Router Wiki 菜单配置文件
    • config.json:Router Wiki 风格配置
    • *.md:Router 各模块文档
    • *.jpg:Router 文档中用到的图片
  • upload:wiki文档上传工具
  • MSDK文档指引.html:MSDK文档相关链接

WIKI链接

  • Wiki 地址:
    • Android Wiki:http://wiki.dev.4g.qq.com/v2/android/index.html
    • IOS Wiki:http://wiki.dev.4g.qq.com/v2/ios/index.html
    • 后台 Wiki:http://wiki.dev.4g.qq.com/v2/router/index.html
  • MSDK版本历史:
    • Android 版本历史:http://wiki.dev.4g.qq.com/v2/android/index.html#!version.md
    • IOS 版本历史:http://wiki.dev.4g.qq.com/v2/ios/index.html#!version.md

MDWiki相关介绍:

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏厦门SEO

网站速度优化之“动静分离”、有效减轻后端服务器压力!

在介绍动静分离之前,我感觉还是有必要介绍一下:什么是静态网站?什么是动态网站?由于我之前已经在一篇个人博客中详细介绍了动静态网站,在这里就不再做详细的描述(有需...

3359
来自专栏腾讯移动品质中心TMQ的专栏

TBS三方SDK自动化探索

对于非宿主的合作伙伴来说,在TBS接入环节,“共享和下载内核”的能力是最重要的,它从根本上决定着APP是否能够使用预期的X5内核提供服务。一旦出现问题,会导致无...

4100
来自专栏更流畅、简洁的软件开发方式

【自然框架】通用权限的视频演示(一):添加角色,权限到功能节点和按钮

      写了几个关于权限的东东,好像大家都不大理解,也不太清楚我的权限到底能做什么,所以想来想去还是弄点视频吧,就是屏幕录像,这样大家看起来就方便了吧。  ...

25610
来自专栏沈唁志

PHP程序猿必知:PHP网站应该怎么做优化

4634
来自专栏tiane12

由Google公共API被屏蔽导致网站加载速度变慢

2363
来自专栏Debian社区

Irssi: 命令行下的 IRC 客户端

IRSSI 是一款优秀的命令行下的 IRC 客户端,支持常见的操作系统,包括Windows、Mac OSX,Debian、RHEL等系统。本文介绍如何在Debi...

1602
来自专栏全华班

互联网云快速开发框架

--我的信息 --我的通告 --文件 2、会员 --用户中心 --用户地图 --积分活动平台 --极光推送 3、营销 --营销活动 --活动汇 --现场活动平台...

2271
来自专栏Thinks

你的第一个渐进式网站应用(1)

渐进式网站应用程序是结合网站和应用程序中最好的体验。它们对于用户来说从浏览器标签中第一次访问,不需要安装是非常有用的。随着用户逐渐建立与应用程序的关系,它变得越...

991
来自专栏皮振伟的专栏

[linux][virt]USB passthrough技术分析

前言: USB passthrough让作者疑惑了一番~ 分析: 1,xml 根据libvirt的官方文档:http://libvirt.org/forma...

35511
来自专栏ytkah

调用{dede:likewords}为dedecms添加相关搜索词

  经常看到一些大型的网站会设置相关搜索,即使访客搜索的内容在本站暂时没有,它们也会展示一些其他搜索关键词,引导用户去点击查看,增加pv,提高用户体验;如果没有...

2904

扫码关注云+社区

领取腾讯云代金券