Github中写文档时的技巧

作者: Lutein | 来源:发表于2017-05-05 18:11 被阅读43次

Github中写文档时的技巧
Java | zuul 1.x 是如何实现请求转发的
YYText使用
写文档时的焦虑
markdown写confluence文档
Markdown语法
vux
vuepress中实现代码折叠、高亮
markdown语法
Java | Spring Cloud Gateway 是如何工

markdown引用块内换行：
用html：在需要换行的段落前使用 
类似的下划线也是：下划线产生下划线
markdown插入公式：
在http://latex.codecogs.com/gif.latex? 中将其转换为图片后插入
因此插入格式为：
![equation1](http://latex.codecogs.com/gif.latex?\theta)
这里的\theta就是需要写入的公式。不过稍微复杂的公式显示似乎有点bug，可以尝试用\\theta这样的格式（不过我没有成功）
另外可以将格式改为svg，比较清晰，即![equation1](http://latex.codecogs.com/svg.latex?\theta)
打开.html文件：
上传html格式的文件到仓库后，打开时是代码形式，需要在地址栏中加上前缀http://htmlpreview.github.io/?
如果是html格式的文档，需要插入公式：
使用mathjax插件，主页地址：http://mathjax-chinese-doc.readthedocs.io/en/latest/start.html
需要将以下内容写到<head>中：

<script type="text/javascript"
  src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
</script>

然后在<body>中用latex写公式。
一个完整例子：

<!DOCTYPE html>
<html>
<head>
<title>MathJax TeX Test Page</title>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({tex2jax: {inlineMath: [['$','$'], ['\\(','\\)']]}});
</script>
<script type="text/javascript"
  src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
</script>
</head>
<body>
When $a \ne 0$, there are two solutions to \(ax^2 + bx + c = 0\) and they are
$$x = {-b \pm \sqrt{b^2-4ac} \over 2a}.$$
</body>
</html>