6

SRE Lesson One -- Day2 熟练使用 Markdown

 2 years ago
source link: https://blog.51cto.com/erdong/5409959
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
neoserver,ios ssh client

SRE Lesson One -- Day2 熟练使用 Markdown

原创
SRE Lesson One -- Day2 熟练使用 Markdown_SRE

工作中有很多内容需要被记录,记录的地方有很多,比如 Git、Wiki 以及公司内的各种知识库系统。除了工作内的事务,还有日常记录笔记的需求,那么这么多需要记录的,有什么统一的格式语法吗?还是都记录在 Word 文档和 TXT 文本里,这些都已经落伍了,而且记录以后没法检索,查找复杂,所以建议新手学习 Markdown 语法。

Markdown 是一种轻量级标记语言,排版语法简洁,让人们更多地关注内容本身而非排版。它使用易读易写的纯文本格式编写文档,可与 HTML 混编,可导出 HTML、PDF 以及本身的 .md 格式的文件。因简洁、高效、易读、易写,Markdown 被大量使用,如 Github、Wikipedia、简书、各个博客系统、各种笔记软件等。

使用 Markdown 的优势

Markdown 相较 Word、TXT 等记录方式有很多有点

  • 语法简单,易于学习
  • 使用方便,在写的过程中基本不需要关心格式,只需要写作,后续的展示渲染都非常好看。
  • 多平台支持,比如 InfoQ、StackOverflow、CSDN、掘金、简书、GitBook、有道云笔记、V2EX 都支持 Markdown,主流的代码托管平台如 GitHub、GitLab、BitBucket、Coding、Gitee 等等,都支持 Markdown 语法,很多开源项目的 README、开发文档、帮助文档、Wiki 等都用 Markdown 写作。
  • 独立且可迁移,Markdown 的编写不受操作系统的限制,使用任何文本软件都可以编辑,且拷贝到其他系统或电脑后可以打开。而且非常方便和他人分享
  • Markdown 可以适应未来的变化。即使你正在使用的应用程序将来会在某个时候不能使用了,你仍然可以使用文本编辑器读取 Markdown 格式的文本。当你的笔记想要长期保存的时候一定要考虑这个因素,否则时间长了之前的文件有可能就打不开了。

关于 Markdown 的语法可以参考 Markdown 的官方教程 ​ ​https://markdown.com.cn/basic-syntax/​​ 。

本文收录于 ​SRE Lesson One ​ ,后续的问题修正和内容变化会持续更新在 ​ ​https://github.com/erdong/SRE-Lesson-One​​ 里。

  • 收藏
  • 评论
  • 分享
  • 举报

Recommend

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK