Github工程中的Markdown语言应用

Posted lida2003

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Github工程中的Markdown语言应用相关的知识,希望对你有一定的参考价值。

Github工程中的Markdown语言应用

最早开源代码中,接触的最多的就是Readme文件,这种txt文件会提供必要的编译,打包,设计等。

随着技术的发展,软件系统复杂度的提升,再快节奏的技术开发工作,尤其是组件化的模块应用。很多时候没法细细体会、阅读这些技术详细信息。

我们知道在某些表达层面:

  • 视频 胜过 图
  • 图 胜过 表
  • 表 胜过 文字

为了解决这个问题,但又要保留txt文档易于编辑和保存,差异化比较的优势,Markdown语法应运而生,且在GitHub开源项目和blog上得到大量应用。

这里我们简单介绍Markdown入门,至于高阶,复杂的功能,相信大家接触的越多,自然而然会有更多体会,这里仅仅是个入门101介绍,希望对大家有帮助。

1. 介绍

Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。

Markdown 语言在 2004 由约翰·格鲁伯(英语:John Gruber)创建。

Markdown 编写的文档可以导出 html 、Word、图像、PDF、Epub 等多种格式的文档。

Markdown 编写的文档后缀为 .md, .markdown。

2. 工具

欲善其事必先利器,这里推荐一款常用的工具VS Code。

2.1 下载链接

Visual Studio Code

2.2 编辑界面

左边栏:工程目录
中间栏:编辑文件
右边栏:文件预览

2.3 插件安装

这里有三个基本插件需要安装,安装完成后请重启VS code。



3. 基本操作

3.1 标题编写

3.2 正文编写

3.3 代码块编写

3.4 加粗倾斜

3.5 有序列表

3.6 无序列表

3.7 行内代码编写

4. 参考资料

【1】Markdown教程
【2】Visual Studio Code工具

以上是关于Github工程中的Markdown语言应用的主要内容,如果未能解决你的问题,请参考以下文章

Markdown 教程

震惊!Markdown居然这么好用!

[转]Markdown 新手指南

Markdown

Markdown语言怎么用

关于github中的README.md文件