# YangPython **Repository Path**: arlionn/YangPython ## Basic Information - **Project Name**: YangPython - **Description**: 杨柳 - Python 团队 - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 5 - **Created**: 2020-02-02 - **Last Updated**: 2022-05-19 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # YangPython ## 介绍 杨柳 - Python 团队 杨柳可以进入 抽取介绍性文字,以便完善该 Readme 文件。 下面我贴了一些文字,你酌情修改吧。     ### 1. 项目介绍 大家好,在现场班培训正式开始之前,我们需要写一些推文来对相关的基础知识进行介绍,每人完成 2 篇推文 (具体数量取决于推文的难度和质量)。 这些推文都是采用 Markdown 语法写的,非常适合在网页上展示。我平时使用的 [知乎](https://zhuanlan.zhihu.com/arlion) | [简书](http://www.jianshu.com/u/69a30474ef33) | [码云](https://gitee.com/arlionn),以及有道云笔记,都充分借助了 Markdown 语法的简洁和高效。 > **特别提示:** 建议申请一个 [简书](http://www.jianshu.com/) 账号,然后在右上角图标的下拉菜单中选择 【设置】→ 【常用编辑器】→ 【Markdown 编辑器】。推文请在简书中写,可以实时预览,实时保存,支持图片拖拽和批量上传,以及 LaTeX 格式的数学公式。全部推文完成后贴入码云中你的项目主页下即可。 我为每一位助教设立了一个文件夹,后续完成推文过程中的相关资料都存放在这个文件夹里。项目完成中过程中的讨论在下方的留言区里面完成。 由于在连享会的工作平台里多数的项目都是公开项目,所以我鼓励大家相互串门,了解一下其他的老师和同学们的项目的进展,互相学习。 ### 2. 注册和工作流程 1. 申请注册[码云](https://gitee.com/)账号:https://gitee.com/ 。有关账号设置和码云使用说明,请查看 [-连玉君-码云使用指南-](https://gitee.com/Stata002/Hello/tree/master/%E7%A0%81%E4%BA%91%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97) 2. 请点击 [- Stata公众号团队成员邀请码 -](https://gitee.com/Stata002/StataSX2018/invite_link?invite=99d36473e26408ba21ff7ba2c68ed4e671cef973cd33f3c4b7993663152babc5ba8855ba9e0d87b5828b69667c84aeba) 加入本项目工作小组,以便获得在小组中编辑文档的权限。 3. 请阅读 [Stata连享会成员手册-Wikis](https://gitee.com/Stata002/StataSX2018/wikis/%E7%A0%81%E4%BA%91%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97?sort_id=937861),了解 Markdown 和码云的使用方法等内容。 - 关于 Markdown,不需要了解太多的内容,只需要花几分钟看看这个就会了:[五分钟 Markdown 教程](https://gitee.com/Stata002/StataSX2018/wikis/%E4%BA%94%E5%88%86%E9%92%9F%20Markdown%20%E6%95%99%E7%A8%8B.md?sort_id=961850)。如果想了解更多,可以看 [[连玉君 Markdown 笔记]](https://www.jianshu.com/p/db1d26af109d) - 关于码云,只需要注意如下几点即可:(1) 可以在自己的文件夹下新建文件夹;(2) 新建的推文文件务必要加上后缀 `.md`,如 `推文1:如何使用stata.md`,否则对应的文件不支持 Markdown 语法。(3) 如果这篇推文中包含数据文件、Stata程序或 PDF 文件附件,可以在项目文件夹下新建名为 【Refs】、【Data】、【prog】之类的文件夹,用于存放这些文件。总体的原则是:没篇推文一个文件夹,可以根据需要设定子文件夹,保证每个项目的文件存储结构清晰、易读。 ## 3. 推文的写作工具 - 建议使用 Markdown 语句撰写论文简介。Markdown 语法参见 [五分钟 Markdown](https://www.jianshu.com/p/b23deec6ff54),或[「Markdown 简明笔记」](https://segmentfault.com/a/1190000019225787?utm_source=tag-newest) - 编辑器1:[「简书」](https://www.jianshu.com/)。请申请一个简书账号,参照【图1】中的方法将编辑器设定为 Markdown 模式。 - 在线编辑器: - [mdnice.com](https://mdnice.com/),极力推荐。详情参见 [这里](https://www.jianshu.com/p/6167e6f97c32)。 - [mdeditor.com](https://www.mdeditor.com/),很全面的在线 Markdown 编辑器 - 完成后的推文请在 mdnice.com 网站进行测试,保证图片和文字信息完整。 --- ### 4. 推文写作格式要求 > **特别注意:** 除非万不得已,尽量不要用图片形式展示 Stata 结果。推文中的 Stata 结果尽量采用结果窗口中呈现的文本信息来呈现,也就是采用代码块来呈现估计结果。这样就不会过度依赖图床,图床一旦出问题,就会导致推文中的所有图片都无法正常显示。另外,使用文本块显示结果可以获得更好的跨平台展示效果。 1. **标题和层级:** 推文的各个小节需要顺序编号,一级标题用 **「## 1. 一级标题」** (说明:`##` 后要添加一个空格),二级标题用 **「### 1.1 二级标题」**,最多用到三级标题,即「#### 1.1.1 三级标题」。如果后续还需细分,可以用 **条目(item)** 或独占一行的粗体文字代替。这主要是因为,多数 Markdown 编辑器的一级标题字号都太大了。 1. **段落:** 段落之间要空一行,这样网页上的显示效果比较好;每个段落不要太长 (最好不好超过 200 字,4 行以内比较好),否则网页或手机阅读时会比较累; 1. **中英文混排**:英文字符和数字两侧要空一格,否则中英文混排时字符间距过小;例如:「**我用Stata已经15年了(Cox,2019),但Arlion(2018)说他刚用了14年。**」要修改为:「**我用 Stata 已经 15 年了 (Cox, 2019),但 Arlion (2018) 说他刚用了 14 年。**」。注意,文中所有圆括号都要在半角模式下输入,`(` 左侧和 `)` 右侧各添加一个空格。 1. **Stata 相关** - Stata 要写为 「Stata」(首字母大写,无需加粗),不要写成 「stata」或「STATA」。 - 变量名用粗体 (如 \*\*varname\*\* → **varname**); - Stata 命令用高亮显示 (如 \`regress\` → `regress`); - 多行 Stata 命令和结果展示使用 **代码块样式**,即使用首尾 **\`\`\`** 包围,首行为 「\`\`\`stata」,尾行为「\`\`\`」。 - **特别注意:** 除非万不得已,尽量不要用图片形式展示 Stata 结果。推文中的 Stata 结果尽量采用结果窗口中呈现的文本信息来呈现,也就是采用代码块来呈现估计结果。这样就不会过度依赖图床,图床一旦出问题,就会导致推文中的所有图片都无法正常显示。另外,使用文本块显示结果可以获得更好的跨平台展示效果。 5. **数学公式:** 用 **\$\$** math **\$\$** 包围的单行数学公式上下各空一行,以保证公式和正文之间的段落间距合理。**惊喜:** 无论是网页还是 PDF 中的数学公式,都可以使用 mathpix (https://mathpix.com/) 软件扫描后识别成 LaTeX 数学公式,非常快捷。参见 [神器-数学公式识别工具 mathpix](https://www.jianshu.com/p/1f0506163694) 6. **图片**: 参见 [如何在 Markdown 中插入图片](https://gitee.com/Stata002/StataSX2018/wikis/%E5%A6%82%E4%BD%95%E5%9C%A8%20Markdown%20%E4%B8%AD%E6%B7%BB%E5%8A%A0%E5%9B%BE%E7%89%87?sort_id=1422837) 1. **版权和引用:** 推文若为英文翻译稿,请务必在文首注明来源(独占一行)。Markdown 格式为:「\**Source:**\[原英文标题](网址)」,显示效果为「**Source:**[原英文标题](网址)」。文中若有从别处复制粘贴而来的内容,要标明出处。 1. **底部文本:** 推文底部的文字介绍无需添加,在修改完后会由总编统一添加。