先掌握 Markdown——用纯文本写出清晰的技术文档;再学习 Git——用版本控制管理每一次变更;最后认识软件许可证,让开源协作有法可依。
Markdown 是一种用简单语法代替复杂排版的标记语言——专注内容创作,而无需分心调整格式。
.md / .markdown;兼容所有文本编辑器;被 GitHub、知乎、简书等平台原生支持。
| 标准体系 | 说明 |
|---|---|
| CommonMark | 标准化的 Markdown 版本,统一语法行为,是「通用地基」 |
| GFM | GitHub Flavored Markdown,增加表格、任务列表、删除线等 |
| 扩展语法 | 各平台定制(如 Mermaid 图表、公式),需显式标注 |
| 元素 | 语法示例 |
|---|---|
| 标题 | # 一级 ## 二级 ### 三级 |
| 粗体 / 斜体 | **粗体** *斜体* |
| 无序 / 有序列表 | - 项目 1. 项目 |
| 链接 | [文字](url) |
| 图片 |  |
| 引用 | > 引用内容 |
| 行内代码 / 代码块 | `code` ```语言 … ``` |
| 任务列表(GFM) | - [ ] 待办 - [x] 完成 |
-;优先使用 CommonMark 标准语法。版本控制记录和管理文件变更,让开发者能追踪历史、并行协作、随时回滚。Git 是当前最流行的分布式版本控制系统。
| 特性 | 本地 VCS | 集中式(SVN) | 分布式(Git) |
|---|---|---|---|
| 数据存储 | 本地 | 中央服务器 | 每人完整副本 |
| 是否需网络 | 否 | 提交/更新时需要 | 仅同步时需要 |
| 单点故障 | 有 | 有(服务器) | 无 |
| 分支效率 | 低 | 低 | 高(轻量分支) |
| 典型工具 | RCS | SVN、CVS | Git、Mercurial |
git add → 暂存区 git commit → 本地分支 git push → 远程仓库;git clone 复制完整仓库。git switch -c 保存。
git add → git commit。切勿对已推送的共享分支执行 rebase。| 场景 | 命令 / 做法 |
|---|---|
| 初始化 / 克隆 | git init git clone <url> |
| 查看状态与差异 | git status git diff |
| 暂存与提交 | git add . git commit -m "说明" |
| 分支 | git branch git switch -c feat/xxx |
| 同步远程 | git pull git push |
| 撤销(工作区) | git restore file |
.gitignore 排除;main 分支受保护,禁止直接推送。软件许可证是用户与版权所有者之间的法律合同,规定使用、修改、分发软件时必须遵守的规则——用别人的代码前,先看许可证。
| 协议 | 宽松程度 | 核心特点 | 典型项目 |
|---|---|---|---|
| GPL | 最严格 | 传染性:衍生作品必须开源 | Linux、Git |
| LGPL | 较严格 | 动态链接可闭源;改库本身须开源 | 部分系统库 |
| Apache 2.0 | 宽松 | 宽松 + 专利授权条款 | Android、Kubernetes |
| MIT / BSD | 最宽松 | 保留版权声明即可,可闭源商用 | 大量前端库、工具 |
先动手试官方文档与交互工具,再深入原理。
Markdown 官方标准化规范与交互式教程。
官方手册、Pro Git 免费电子书与命令速查。
中文经典入门:从安装配置到分支管理。
可视化分支练习:merge / rebase / cherry-pick。
代码托管与协作:fork、PR、Issues 完整流程。
按项目目标推荐合适的开源许可证。
开源定义与 OSI 认证许可证原文。
国内平台操作指南:仓库、PR、团队协作。