docs: modify README.md

README.md

@@ -0,0 +1,27 @@
+# 工作中的技能经验总结
+
+> 采用 sphinx 和 Markdown 构建 ReadTheDocs 文档
+
+## 传统 rst 语法构建
+
+[使用 ReadtheDocs 托管技术文档](https://www.jianshu.com/p/8aae1c1453ae)
+
+## 采用 Markdown 语法
+
+[recommonmark](https://github.com/readthedocs/recommonmark)
+
+注意 `Sphinx` 版本
+
+```
+# for Sphinx-1.4 or newer
+extensions = ['recommonmark']
+
+# for Sphinx-1.3
+from recommonmark.parser import CommonMarkParser
+
+source_parsers = {
+    '.md': CommonMarkParser,
+}
+
+source_suffix = ['.rst', '.md']
+```