StataSX2018
1. 项目介绍
Stata 连享会团队工作平台。
大家好,在现场班培训正式开始之前,我们需要写一些推文来对相关的基础知识进行介绍。这些推文都是采用 Markdown 语法写的,非常适合在网页上展示。我平时使用的 知乎 | 简书 | 码云,以及有道云笔记,都充分借助了 Markdown 语法的简洁和高效。
我为每一位助教设立了一个文件夹,后续完成推文过程中的相关资料都存放在这个文件夹里。项目完成中过程中的讨论在下方的留言区里面完成。
由于在连享会的工作平台里多数的项目都是公开项目,所以我鼓励大家相互串门,了解一下其他的老师和同学们的项目的进展,互相学习。
2. 注册和工作流程
- 申请注册码云账号:https://gitee.com/ 。有关账号设置和码云使用说明,请查看 -连玉君-码云使用指南-
- 请点击 - Stata公众号团队成员邀请码 - 加入本项目工作小组,以便获得在小组中编辑文档的权限。
- 请阅读 Stata连享会成员手册-Wikis,了解 Markdown 和码云的使用方法等内容。
- 关于 Markdown,不需要了解太多的内容,只需要花几分钟看看这个就会了:五分钟 Markdown 教程。如果想了解更多,可以看 [连玉君 Markdown 笔记]
- 关于码云,只需要注意如下几点即可:(1) 可以在自己的文件夹下新建文件夹;(2) 新建的推文文件务必要加上后缀
.md
,如 推文1:如何使用stata.md
,否则对应的文件不支持 Markdown 语法。(3) 如果这篇推文中包含数据文件、Stata程序或 PDF 文件附件,可以在项目文件夹下新建一个名为 【Data】之类的文件夹,用于存放这些文件。
3. 推文选题
选题有三个来源:
3.1 参考项目
如下几位的推文项目主页都做的非常好,供大家参考:
3.2 特别说明
- 选定主题后,请微信通知我确认一下,自拟提纲开始写作 (如有疑问可以随时联系我讨论)
- 每篇推文是一个项目,每个项目下新建一个以
.md
为后缀的 Markdown 文档,用于推文的撰写;如有需要,可以新建子文件夹用于存放数据,程序等附件资料。
4. 推文写作格式要求
特别注意: 除非万不得已,尽量不要用图片形式展示 Stata 结果。推文中的 Stata 结果尽量采用结果窗口中呈现的文本信息来呈现,也就是采用代码块来呈现估计结果。这样就不会过度依赖图床,图床一旦出问题,就会导致推文中的所有图片都无法正常显示。另外,使用文本块显示结果可以获得更好的跨平台展示效果。
-
标题和层级: 一级标题用 「## 1. 一级标题」,二级标题用 「### 1.1 二级标题」,最多用到三级标题,即「#### 1.1.1 三级标题」。如果后续还需细分,可以用 条目(item) 代替。这主要是因为,多数 Markdown 编辑器的一级标题字号都太大了。
-
段落: 段落之间要空一行,这样网页上的显示效果比较好;每个段落不要太长 (最好不好超过 200 字,4 行以内比较好),否则网页或手机阅读时会比较累;
-
中英文混排:英文字符和数字两侧要空一格,否则中英文混排时字符间距过小;例如:「我用Stata已经15年了」要修改为:「我用 Stata 已经 15 年了」
- Stata 相关
- Stata 要写为 「Stata」(首字母大写,无需加粗),不要写成 「stata」或「STATA」。
- 变量名用粗体 (如 **varname** → varname);
- Stata 命令用高亮显示 (如 `regress` →
regress
);
- 多行 Stata 命令和结果展示使用 代码块样式,即使用首尾 ``` 包围,首行为 「```stata」,尾行为「```」。
-
特别注意: 除非万不得已,尽量不要用图片形式展示 Stata 结果。推文中的 Stata 结果尽量采用结果窗口中呈现的文本信息来呈现,也就是采用代码块来呈现估计结果。这样就不会过度依赖图床,图床一旦出问题,就会导致推文中的所有图片都无法正常显示。另外,使用文本块显示结果可以获得更好的跨平台展示效果。
-
数学公式: 用 $$ math $$ 包围的单行数学公式上下各空一行,以保证公式和正文之间的段落间距合理。惊喜: 无论是网页还是 PDF 中的数学公式,都可以使用 mathpix (https://mathpix.com/) 软件扫描后识别成 LaTeX 数学公式,非常快捷。参见 神器-数学公式识别工具 mathpix
-
图片: 参见 如何在 Markdown 中插入图片
-
版权和引用: 推文若为英文翻译稿,请务必在文首注明来源(独占一行)。Markdown 格式为:「**Source:**[原英文标题](网址)」,显示效果为「Source:原英文标题」。文中若有从别处复制粘贴而来的内容,要标明出处。
-
底部文本: 推文底部的文字介绍无需添加,在修改完后会由总编统一添加。