MarkDown语法记录,还在用word,txt编写项目文档吗?
开始之前
是不是在github上看项目的时候第一眼就要看项目介绍? 是不是经常在某些项目的代码里面看到一个README.MD文档 却不知道怎么写?
你是不是不知道,反正我是的。
作为一个程序员,可能写了几年之后都会或多或少的需要写一份可以帮助别人快速了解你的项目的文档,这个时候如果你用txt或者word来写 ,是不是有点不够逼格,又或排版略显麻烦?
那么它来了 —— MarkDown
Markdown是一种轻量级的标记语言,使用极为简单的语法就可以实现 段落,文字字体,超链接,图片,代码块,表格 等等等 模块。非常的简单实用帮助我们快速编辑一个HTML文档。
快速开始
标题
标题的实用很常见,像html的“H”标签一样 h1-h6表达标题字体大小 ,同理,在 md中使用 “#” 来表达标题级别,通过数量来决定标题大小 ,1个“#”即代表 1级标题,即最大的标题。
只需要在想要作为标题的文字前加对应的“#”数量即可以完成。(注意:“#”号的最后,文字前需要加一个空格 这个最好是加上 因为有一些编辑器可能不加无法识别 )
一级标题
# 一级标题
二级标题
## 二级标题
三级标题
###三级标题
四级标题
#### 四级标题
五级标题
##### 五级标题
六级标题
###### 六级标题
是不是很简单?
字体
字体是文章很重要的一部分,有些需要读者重点了解的内容,只需要将字体像这样 加粗 ,变斜,或者又粗又斜,又或者修改文档增加注释废弃的代码。
如此表达是不是很清晰?
敲黑板
粗体
普通:粗体
加粗:粗体 **粗体**
斜体
普通:斜体
变斜:斜体 *斜体*
又粗又斜
普通:又粗又斜
粗斜:又粗又斜 ***又粗又斜***
删除线 废弃线
普通:删除,废弃
删除,废弃:删除,废弃 ~~删除,废弃~~
引用
有时候 需要引用别的文章/句式/代码等 可以使用引用块 表达
人到中年不得已 保温杯里泡枸杞 -某位程序员
>人到中年不得已 保温杯里泡枸杞 -某位程序员
只需要在引用之前 加一个“>”即可
分割线
博客的md编辑器好像不太行 应该是对分割线做了一些东西,显示不出来。用法如下
---
***
两种方式都可以实现分割线。
图片
图片有两种形式: 本地图片 网络图片
写法实际是一样的
[图片上传失败...(image-a4462c-1602734880148)]
![网络图片](https://ss2.bdstatic.com/70cFvnSh_Q1YnxGkpoWK1HF6hhy/it/u=768863205,4008355431&fm=15&gp=0.jpg)
![图片描述](图片url)
如果是本地图片 图片url替换成为图片本地路径就可以。
超链接
[这里会跳转到非常神奇的一个地方,在这里我们可以遨游互联网](https://www.baidu.com)
[链接文字](链接)
没错,超链接与加载图片的写法只差了一个“!”
列表
列表其实是一个非常常用的功能 ,列表的排版会让文章调理更清晰,更方便划清重点。
- A
- B
- C
只需要在内容前加“- ”(减号+空格)即可.
- A
- B
- C
表格
表格我就不多说了吧?直接上用法:
姓名 | 性别 | 年龄 | 专业 |
---|---|---|---|
二狗子 | 男 | 28 | android开发工程师 |
小美 | 女 | 18 | python开发工程师 |
铁柱 | 未知 | 30 | java开发工程师 |
姓名|性别|年龄|专业
--|--|--|--
二狗子|男|28|android开发工程师
小美|女|18|python开发工程师
铁柱|未知|30|java开发工程师
这也太简单了吧???
代码块
public static void main(){
Log.d(TAG,"hello,md");
}
代码块用 ` 三个放在开头 三个放在结尾,代码放在中间即可。
像这样:
```
public static void main(){
Log.d(TAG,"hello,md");
}
```
高级进阶
感谢小伙伴读到了这里,下面我们来介绍一下高级进阶用法
高级的用法我也是在网上通过其他大神或者教学网站整理而来,如果有侵权行为,请私信我 ,我这面立即就会整改
转义
Markdown 使用了很多特殊符号来表示特定的意义,如果需要显示特定的符号则需要使用转义字符,Markdown 使用反斜杠转义特殊字符:
例如:
文本加粗
** 正常显示星号 **
**文本加粗**
\*\* 正常显示星号 \*\*
公式
数学公式这块 我还有点没太弄明白 等我弄明白了 我再回头来分享给大家。
工具
工具其实在线的就有很多,能直接预览你编辑的MD 。我个人更偏向使用本地的工具,编辑预览起来更方便,功能也更强大一些。
在这里给大家推荐一个练习或者编辑使用的编辑器:
Typora-MD编辑器
这应该是我用过的最好用的编辑器了,大家可以下载一下 平时练习使用。
我是一名android开发者,目前想考虑转一下方向去做服务端架构和代码编写,目前正在从头开始学习java。
这个博客是刚刚注册的, 哪怕虽然我已经做了8年的程序员,但一直都在索取,现在希望在学习的过程中,记录下来问题和经验,来帮助更多需要帮助的人。
MarkDown语法记录,还在用word,txt编写项目文档吗?的更多相关文章
- 基于 Markdown 编写接口文档
最近公司开发项目需要前后端分离,这样话就设计到后端接口设计.复杂功能需要提供各种各样的接口供前端调用,因此编写API文档非常有必要了 网上查了很多资料,发现基于Markdown编写文档是一种比较流行而 ...
- 使用 VS Code + Markdown 编写 PDF 文档
背景介绍 作为一个技术人员,基本都需要编写技术相关文档,而且大部分技术人员都应该掌握 markdown 这个技能,使用 markdown 来编写并生成 PDF 文档将会是一个不错的体验,以下就介绍下如 ...
- word中怎样把文档里的中文以及中文字符全选?
word中怎样把文档里的中文以及中文字符全选? 参考: 百度 案例: 有个文档是中英文混杂的 现在需要把中文以及中文字符全部设置成别的颜色 应该怎样操作? 有80多页 别说让我一个一个的设置 以wor ...
- MarkDown 语法记录
Markdown是一种纯文本格式的标记语言.通过简单的标记语法,它可以使普通文本内容具有一定的格式. 为啥要用 MarkDown 呢? 优点 1.因为是纯文本,所以只要支持Markdown的地方都能获 ...
- 使用Spec Markdown 编写手册文档
Spec Markdown 是一个基于markdown 的文档编写工具,安装简单,可以让我们编写出专业的文档 参考项目 https://github.com/rongfengliang/spec-md ...
- markdown语法记录
换行:在结尾加两个空格后回车. 缩进:将输入法切换到全角,两个空格就是两个汉字的大小.
- mac Word 怎样放大缩小文档结构图文字大小
在文档结构图的侧栏里按住control+option,然后滑动鼠标滚轮/双指上下滚动触摸板.
- WORD中引用活动文档元素
要引用活动的段落.表格.域或其他文档元素,可使用 Selection 属性返回一个 Selection 对象.通过 Selection 对象,可访问选定内容中的所有段落或第一段.下列示例将边框应用于选 ...
- Markdown编写接口文档模版
接口名称 1) 请求地址 https://apis.cnblogs.com/user/info?a=xx&b=xx 2) 调用方式:HTTP GET 3) 接口描述: 接口描述详情 4) 请求 ...
随机推荐
- 以jar包为容器的java程序访问一同打到jar包里的配置文件的方法
Java程序有时会被打到jar包里执行,同时src/main/resources里一些配置文件也会被打进去. 比如,src/main/resources下有一个box目录,里面有几个json文件,用m ...
- 跨年夜问题:一句并不复杂的delete竟然在delete statement处cost飙升,在数据量上升的十万级就像进入了死循环,执行后久久没有结果
笔者使用的环境: # 类别 版本 1 操作系统 Win10 2 数据库 Oracle Database 11g Enterprise Edition Release 11.2.0.1.0 - 64bi ...
- 教会舍友玩 Git (再也不用担心他的学习)
舍友长大想当程序员,我和他爷爷奶奶都可高兴了,写他最喜欢的喜之郎牌Git文章,学完以后,再也不用担心舍友的学习了(狗头)哪里不会写哪里 ~~~ 一 先来聊一聊 太多东西属于,总在用,但是一直都没整理的 ...
- ThinkPHP6.0 多应用模式 部署 Layuiadmin 单页版
TP6.0中的路由省略应用名只能用入口文件绑定应用 和 域名绑定应用,经过测试,最后得出域名绑定应用是最合适的部署方式.如果有更好的部署方案,欢迎分享.QQ:23426945 1. 下载TP6.0,引 ...
- 入门alibaba的EasyExcel
一.关于EasyExcel 1.什么是EasyExcel,有什么作用? EasyExcel是一个基于Java的简单.省内存的读写Excel的开源项目.在尽可能节约内存的情况下支持读写百M的Excel. ...
- sudo提权,ansible批量给所有主机创建系统账户,授权
sudo(superuser or another do)让普通用户可以以超级管理员或其他人的身份执行命令. sudo基本流程如下: 1.管理员需要先授权(修改/etc/sudoers文件) 2.普通 ...
- HTML全局属性(global attribute)有哪些(包含H5)
1.accesskey:提供了为当前元素生成键盘快捷键的提示.这个属性由空格分隔的字符列表组成.浏览器应该使用在计算机键盘布局上存在的第一个. 2.autocapitalize:控制用户的文本输入是否 ...
- 透过 Cucumber 学习 BDD
在需求的开发过程中,最令人困惑的地方就在于需求模糊.需求是解决业务的问题,那么验收的方式应该是由业务方提出,但是往往业务方(可能是产品经理,也可能是直接是客户)只能给出比较模糊的一个验收标准,而程序却 ...
- 源码上看 .NET 中 StringBuilder 拼接字符串的实现
前几天写了一篇StringBuilder与TextWriter二者之间区别的文章(链接).当时提了一句没有找到相关源码,于是随后有很多热心人士给出了相关的源码链接(链接),感谢大家.这几天抽了点时间查 ...
- Flex、Grid、媒体查询实现响应式布局
本篇文章主要讲述使用Flex布局.Grid布局以及媒体查询三种方式来实现响应式布局. 文章涉及代码在线coding地址 效果图: 文字描述: 屏幕大小不同,展示列数不同,1-5号按照屏幕大小可展示2到 ...