Github工程中的Markdown语言应用

news2025/7/2 13:49:22

Github工程中的Markdown语言应用

  • 1. 介绍
  • 2. 工具
    • 2.1 下载链接
    • 2.2 编辑界面
    • 2.3 插件安装
  • 3. 基本操作
    • 3.1 标题编写
    • 3.2 正文编写
    • 3.3 代码块编写
    • 3.4 加粗倾斜
    • 3.5 有序列表
    • 3.6 无序列表
    • 3.7 行内代码编写
  • 4. 参考资料

最早开源代码中,接触的最多的就是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
VSC工具

2.2 编辑界面

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

2.3 插件安装

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

VS code中文简体包
Markdown All in One
Markdown Preview Github styling

3. 基本操作

3.1 标题编写

在这里插入图片描述

3.2 正文编写

在这里插入图片描述

3.3 代码块编写

在这里插入图片描述

3.4 加粗倾斜

在这里插入图片描述

3.5 有序列表

在这里插入图片描述

3.6 无序列表

在这里插入图片描述

3.7 行内代码编写

在这里插入图片描述

4. 参考资料

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

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/5300.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

Altium格式PCB转换成Allegro操作指导

Altium格式PCB转换成Allegro操作指导 首先打开Altium Design的PCB文件,输出一个“PCB ASCII File(*.pcbdoc)”格式的文件。如下图 打开Allegro,选择was performance L模式,新建空白的brd。 导入Altium PCB 选择文件转换即可 转换成功 This section is describe what t…

Spring更简单的实现Bean对象的存取

目录 一、前言: 二、储存Bean对象 5大类注解 Bean方法注解 三、获取Bean对象 属性注入 优缺点 Setter注入 优缺点分析 构造方法注入 优缺点分析 经典面试题 :属性注入 ,构造方法注入 和 Setter 注入 之间,有什么区别…

大数据Presto(四):Presto自定义函数和JDBC连接

文章目录 Presto自定义函数和JDBC连接 一、Presto 自定义函数 1、​​​​​​​UDF函数 2、​​​​​​​UDAF函数 二、Presto JDBC连接 Presto自定义函数和JDBC连接 ​​​​​​​一、Presto 自定义函数 我们可以登录Presto客户端,使用命令:s…

JavaScript 71 JavaScript JSON 71.5 JSON.parse()

JavaScript 文章目录JavaScript71 JavaScript JSON71.5 JSON.parse()71.5.1 实例 – 解析 JSON71.5.2 来自服务器的 JSON71.5.3 作为 JSON 的数组71.5.4 例外71.5.5 浏览器支持71 JavaScript JSON 71.5 JSON.parse() JSON 的常规用途是同 web 服务器进行数据传输。 在从 web…

Hive笔记-01 架构概述

文章目录1.概述2.Metadata/Metastore的作用3 Metastore三种配置方式3.1 Hive配置参数说明3.1.1 基本配置参数3.1.2 其他配置参数3.2 内嵌模式(Embedded) 3.2.1 hive-site.xml配置说明 3.2.2 hive-site.xml配置样例3.2.3 启动方式3.2.4 缺点3.3 本地模式&…

cmd常用命令行

前言 最近在看《深入剖析Tomcat》,其中涉及了常见的dos命令,这里做一些简单记录,其实跟linux命令很像。 案例 .bat:批处理文件 rem:用于注释,解释器不会执行以rem命令开始的行 - pause:暂停…

Executors工具类的相关方法

前言:大家好,我是小威,24届毕业生。本篇将记录创建线程池的Executors工具类里面的方法,方便加深知识印象和复习使用。 本篇文章记录的基础知识,适合在学Java的小白,也适合复习中,面试中的大佬&a…

Matlab之机载雷达系统中的空时自适应处理(STAP)技术(附源码)

目录 一、介绍 二、系统设置 2.1 天线定义 2.2 雷达设置 2.3 目标 2.4 杂波 2.5 传播路径 三、模拟循环 3.1真实目标范围、角度和多普勒 3.2 使用 DPCA 消除器进行杂波抑制 ​四、总结 五、程序 本例简要介绍了空时自适应处理(STAP)技术&…

【C++】模板进阶 —— 非类型模板参数 | 特化 | 模板的分离编译

🌈欢迎来到C专栏~~模板进阶 (꒪ꇴ꒪(꒪ꇴ꒪ )🐣,我是Scort目前状态:大三非科班啃C中🌍博客主页:张小姐的猫~江湖背景快上车🚘,握好方向盘跟我有一起打天下嘞!送给自己的一句鸡汤&…

java线程基础

最近,想弄一个雪花飘落,结果,搞了两三个小时没弄出来。主要是雪花飘落可能需要用到线程。有人是通过一个雪花去实现,然后通过集合去实现漫天雪花。不管怎么说,做开发,可能线程学习也是一块绕不过去的大山。…

【JavaWeb】jsp

文章目录⭐️ 一.jsp概念及其作用⭐️ 二.jsp的本质⭐️三.jsp的三种语法⭐️四.jsp的九大内置对象⭐️五.jsp四大域对象⭐️六.jsp中的out输出和response.getWriter输出的区别⭐️七.jsp的常用标签⭐️八.Listener监听器⭐️ 一.jsp概念及其作用 1.概念:jsp的全称是java serv…

SpringMVC框架中的异常处理机制

目录 1. 什么是异常处理? 2. SpringMVC框架中的异常处理机制是什么? 3. SpringMVC框架汇中实现异常处理的实现步骤 4. SpringMVC框架出现异常时候的处理过程 5. 附手写代码,并含有注释 1. 什么是异常处理? http://t.csdn.cn/x…

【线性代数】四、二次型

第四章 二次型 文章目录第四章 二次型一、二次型定义二、合同变换1.线性变换2.矩阵合同标准型和规范型3.惯性定理三、正定二次型一、二次型定义 如果系数aij全为实数,那么为实二次型。上述二次型展开式可表示用矩阵为 可以看出,二次型矩阵A是一个对称矩…

做了8年前端,细说那些曾经让你浴霸不能的后端

说明:本文并没有针对某位大哥大姐,看见如果觉得好笑的就笑一笑,如果被戳中了你的过往,请不要气愤,人活着嘛,开心最重要。 A 曾经有个后端,我要调一个详情。他告诉我传id,然后测试的…

LeetCode 790. 多米诺和托米诺平铺

LeetCode 790. 多米诺和托米诺平铺一、题目(经典动态规划)二、解题思路1. 铺满2*N面积:2. 对于第i列,有4种情况:3. N-1 -> N 转移方程:三、核心代码四、代码中存在的一些知识性问题1. 二层vector的定义、…

浅谈JVM

内存结构: 程序计数器(寄存器) 作用:记住下一条jvm指令的执行地址 特点: 是线程私有的 不会出现内存溢出 虚拟机栈 虚拟机栈:是描述java方法执行的内存模型,每个方法在执行的同时都会创建…

生信初学者必知的镜像设置

文章目录Ubuntu镜像conda镜像R语言镜像Python镜像Julia镜像国内网络问题很烂,大家都知道,github、pubmed这些网站经常访问不了!如果你平常会用到Ubuntu、conda、R语言、Python、Julia, 那你肯定为安转各种包、库、软件而烦恼过&am…

​草莓熊python turtle绘图代码(玫瑰花版)附源代码

​草莓熊python turtle绘图代码(玫瑰花版)附源代码 目录 一、前言 二、草莓熊手持玫瑰花成品效果图 三、代码演示方法和代码命令解释 四、草莓熊手持的玫瑰花源代码 五、相关资源图片 六、我的“草莓熊python turtle绘图(玫瑰花版&…

Sparse编码和字典学习(1)基础知识和python简单实现

Sparse编码和字典学习1. 稀疏表示与字典学习简介1.1 Motivation1.2 字典学习的流程1.3 字典学习的数学模型2 python实现2.1字典学习2.1 稀疏性统计和误差计算参考资料和文献1. 稀疏表示与字典学习简介 1.1 Motivation 字典学习的思想应该源来实际生活中的字典的概念。字典是前…

谷粒商城 -- 项目环境搭建

注:以下的项目环境搭建过程,适用于所有的微服务项目的环境搭建,以后做微服务项目的时候看着这个笔记进行搭建环境即可 一、项目微服务划分图 二、Linux安装Docker 三、Docker安装mysql / redis 四、Vscode下载安装 五、谷粒项目结构创建&a…