贡献指南
写在最前¶
- 倡导自愿贡献原则
- 想交流可以加入telegram群
- 可以给GitHub仓库加星
开发任务¶
任务 | 备注 |
---|---|
更新网站架构 | 做分类体系 |
进一步优化网页 | 至少看起来没那么摆 |
细化Organization | 加点描述,捐赠啥的 |
优化国内访问 | 至少能访问吧 |
一些不合理的地方的修缮 | 看到啥就改啥 |
如何将你的见解提交到Easymath-wiki¶
注意,由于Github的服务器主要分布在国外,你可能需要 [科学上网]
如果你是计算机大佬,可以直接跳过这一段,提交PR就行。
如果你是计算机小白,这一段教程或许可以帮助你舒适地为Easymath做出贡献
如果只是想对现有内容做出更改,请直接点击页面右上角的笔状编辑按钮,可以跳转到Github的文件编辑页面,使用兼容markdown的格式进行编辑即可。
如果你想新建一个页面,新加一个定义,或者进行更进一步的编辑,请加入我们的写手群或联系admin@easymath-wiki.org,我们可以提供一对一的教学。(更进一步的指引文档还在编辑中)
如果你不想这么麻烦,也可以直接将Markdown文件发至邮箱admin@easymath-wiki.org,我们在审核后会将你的文章推送到网站上。
Markdown规范¶
- 使用加粗时,前后加上一个空格。
- 英文与中文之间 **加空格 **
数学规范¶
以下规范大多也是论文的规范,养成良好的代码习惯,避免以后写论文时出错哦!
公式规范¶
-
所有的数学公式应该放在行内公式或者行间公式区域。例如
-
正确示范:\(z=x-b/4\),\(f(x)=\sin x\),\(P(A \cup B)\)
-
错误示范:y=kx,P(A∪B)
-
当括号内有增大行高的结构(如分数、根号、矩阵等),括号前须加上\left和\right,例如
-
当公式作为一句话的结尾,或者公式本身就是一句话、一个表达式时,须在公式尾部加上逗号、分号或句号(有序和无序列表时,末尾可以不加标点符号),如:
- 多项式\(f(x)\)和\(g(x)\)的首一最大公因式可以记作
- (大括号内也要注意逗号和分号)
字母规范¶
-
表示变量、函数的单个字母,使用斜体(公式区域的字母默认是斜体),如:
- \(y=f(x)\),\((f\circ g)(x)\)
- \(P(A \cup B)=P(A) + P(B) - P(AB)\) (这里概率\(P\)也是函数,\(P\)将集合映射为实数)
- \(n\)维向量空间,\(a\)的\(x\)次方
-
表示数集、数域的字母用LaTeX的\mathbb属性,如:
- \(1 \in \mathbb{N}\)
- \(\mathbb{Q} \subset \mathbb{R} \subset \mathbb{C}\)
- 一元多项式环\(\mathbb{K}[x]\),\(n\)维向量空间\({\mathbb{K}}^n\)
-
表示人名、单词(包括用单词表示的变量、函数)、单位、化学符号的字母使用正体(\text或\mathrm),如:
- \(2{\text{H}}_2+{\text{O}}_2 \to 2{\text{H}_2\text{O}}\)
- \(\text{Riemann}(x)\),\(\text{rank}(\mathbf{A})\)
- \(L = 1\ \mathrm{m}, \theta = \pi\ \mathrm{rad}\)
-
表示向量(包括数组向量、抽象向量、向量值函数)时用箭头\vec,\overrightarrow或者粗体\mathbf,表示矩阵时用粗体mathbf,如:
- \(\mathbf{A}\overrightarrow{v} = \overrightarrow{b}\)
- 零向量\(\overrightarrow{0}\),零矩阵\(\mathbf{O}\)
- \(\det(\mathbf{AB}) = \det(\mathbf{A})\det(\mathbf{B})\)
-
花体字母统一使用\mathscr,而不是\mathcal:
- 正确示范:线性变换\(\mathscr{A}\),事件域\(\mathscr{F}\)
- 错误示范:\(\mathcal{A}\),\(\mathcal{F}\)
-
不带括号的函数和变量、数和单位之间应该相距一个空格。一般来说,LaTeX内置的函数已经自动带上空格,而数与单位之间则需要自己补上一个反斜杠+空格(“ ”)。
- \(\sin x\),\(\ln x\),\(\det \mathbf{M}\)
- 万有引力常数的大小为\(G = 6.67\times10^{-11}\ \mathrm{N \cdot m^2/kg^2}\)
-
按中国教材的习惯,微分符号\(\mathrm{d}\)、微分算子\(\mathrm{D}\)、自然对数的底\(\mathrm{e}\)、虚数单位\(\mathrm{i}\)一般使用正体,如:
- \(\mathrm{i} = \sqrt{-1}\)
\[ \lim_{n \to \infty} \left(1 + \frac{1}{n} \right)^n = \mathrm{e} \]- \(\mathrm{D}(x^2)=\frac{\mathrm{d}}{\mathrm{d}x}(x^2)=2x\)
隐藏的 Latex 块¶
有些时候,你或许想要使用 \renewcommand
来自定义一些 LaTeX 命令,但是直接在数学块里定义新的 LaTeX 命令会产生一段空白。
因此,我们建议将所有 \renewcommand
命令都放在文章首部的一个隐藏公式块里:
<div class="hidden-latex">
\[
\renewcommand{fracx}{\displaystyle \frac}
\]
</div>