百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术文章 > 正文

如何快速写出高质量文档(Markdown篇)

zhezhongyun 2025-02-13 15:12 65 浏览

Markdown是什么

Mark down的英文直译就是记下的意思(中间有空格),作为一种轻量级的『标记语言』目前已被广泛使用,各大主流的平台和编辑器都有做支持,尤其是Github上使用Readme.md文件作为项目简介的文章就是使用了markdown语言,而这门“语言”无论是学习还是使用起来都非常的简单!


正如作者所说的那样:

Markdown旨在尽可能地易于阅读和易于编写。

-- John Gruber


目前支持了该语言格式的平台包括:

  • github/gitbook
  • wordpress
  • csdn
  • 简书
  • 有道云笔记


了解一点点的HTML

Markdown语法的主要目标是用作web编写的格式。它的灵感来源于纯文本电子邮件。

但是Markdown并不是HTML的替代,它远比HTML小的多,仅实现了HTML语言中的一小部分,它可以用更简单的方式(一种纯文本的方式),来达到HTML显示的效果。


注:如果你看到了HTML语法就感到了困惑的话,那么你大可不必阅读这一部分的内容,因为就算你不了解也没有任何问题。


在浏览器里查看到的网络,使用的是HTML超文本标记语言来实现的,主要是通过一些列的标签来统一文档的格式,涵盖了文字、图形,动画、声音、表格、连接等。

在 HTML5 中还有很多更加丰富的标签类型可以使用,注意哦,这些标签,在markdown文档里,都可以直接使用。但有个别需要注意的地方,在内联HTML模块里我们详细讲述。


然而,markdown却不用像HTML标签那样书写,而是使用一些简单的符号标记即可。(最终他们会输出成HTML标记)


更简洁也更便捷的书写方式

使用Markdown语言的优点主要包括:


关于作者

而Markdown的作者 John Gruber 是一个什么样的人呢?他是一个作家,UI设计师!(也是一个软件工程师)


John Gruber出生于费城,是德雷克塞尔大学计算机科学专业毕业的,在2002年开设了Daring Fireball(主要评论苹果产品、策略,有时也发布一些自己开发的软件)。2004年设计开发了Markdown语言。


Markdown语法速记

一篇文章的构成,主要有 封面,目录,标题,正文,脚注 等构成,在Office的Word里还有更加强大的页眉 页脚,页码 的显示,甚至可以添加 批注。而我们在Markdown里需要关注的并不是一篇word文档的编辑工作(尽管它可以导出成为doc文件),我们更加关注在浏览器里,一个网页里文章的基本展现效果,因此,我们暂时不考虑页眉页脚页码批注等效果,也不用考虑封面。其中对正文的支持,又可以细分到很多表现形式,比如表格、图片等,以下列出了所有支持的段落和格式效果。


(对每个标记的详细说明见文章 《高逼格写作Markdown标记详解》


常用编辑器推荐

Mou

  • 由国人开发的,支持实时预览,但仅支持苹果系统。可以说是目前最好的免费Markdown编辑器,对汉字兼容性非常好;
  • 提供语法高亮、在线预览、同步滚动、全屏模式;
  • 支持自动保存、自动匹配;
  • 允许自定义主题等;
  • 软件网址:http://25.io/mou/
  • 软件预览:



Typora

  • 目前笔者最喜欢用的编辑器,支持 Windows ,MacOS X ,以及 Linux 平台;
  • 特点是真正的即时预览,单窗口展示,编写完后自动识别并直接展示出效果来;
  • 支持源码模式,点击切换后可以仅书写而不展示效果;
  • 支持多种主题,非常方便地扩展不同的样式,以达到不一样的显示效果;
  • 菜单操作非常便捷,如果你忘了如何做标记,那么直接使用菜单里的选项生成即可;
  • 支持导出PDF,HTML,Office Word,图像等多种格式;
  • 软件网址:https://www.typora.io/
  • 软件预览:



Atom

  • 专门为程序员推出的文本编辑器,支持实时预览,支持 Windows ,MacOS X ,以及 Linux 平台;
  • 需要双屏开启预览模式,并非仅为Markdown而设计,是一个可以做变成IDE的软件,由github平台出品;
  • 支持CSS,HTML,JavaScript等网页编程语言,支持宏定义;
  • 支持语义输入模式,比如输入code即开启代码模式;
  • 软件网址:https://atom.io/
  • 软件预览:



Haroopad

  • 来自韩国的一款流程编辑器,支持 Windows ,MacOS X ,以及 Linux 平台;
  • 特点是主题样式特别丰富,语法支持无数种(几乎你能想到的所有)编程语言高亮,Linux用户比例非常高,同时还是一个开源免费的软件;
  • 支持导出HTML,PDF等文件格式;
  • 特别地,支持数学公式和流程图功能;
  • 软件网址:http://pad.haroopress.com/user.html
  • 软件预览:



其他常用的软件

Cmd Markdown

  • 支持3大平台,也有web在线的支持;
  • 软件网站:https://www.zybuluo.com/mdeditor

Byword

  • 主要是苹果平台支持,包括移动端(Mac,iPhone,iPad),但是是收费的;
  • 软件网站:https://bywordapp.com/

CuteMarkEd

  • 支持3大平台,开源免费,提供实时HTML预览,数字表达式功能;
  • 软件网站:https://cloose.github.io/CuteMarkEd/

Dillinger

  • 国外的网站,支持web在线制作,支持保存到Dropbox、bitbucket、github、google drive等平台;
  • 软件网站:https://dillinger.io/

Marxico

  • 马克飞象,有桌面版,Chrome App插件,web集成版,可以直接把文本保存到印象笔记;
  • 软件网址:http://marxi.co/

相关推荐

Python入门学习记录之一:变量_python怎么用变量

写这个,主要是对自己学习python知识的一个总结,也是加深自己的印象。变量(英文:variable),也叫标识符。在python中,变量的命名规则有以下三点:>变量名只能包含字母、数字和下划线...

python变量命名规则——来自小白的总结

python是一个动态编译类编程语言,所以程序在运行前不需要如C语言的先行编译动作,因此也只有在程序运行过程中才能发现程序的问题。基于此,python的变量就有一定的命名规范。python作为当前热门...

Python入门学习教程:第 2 章 变量与数据类型

2.1什么是变量?在编程中,变量就像一个存放数据的容器,它可以存储各种信息,并且这些信息可以被读取和修改。想象一下,变量就如同我们生活中的盒子,你可以把东西放进去,也可以随时拿出来看看,甚至可以换成...

绘制学术论文中的“三线表”具体指导

在科研过程中,大家用到最多的可能就是“三线表”。“三线表”,一般主要由三条横线构成,当然在变量名栏里也可以拆分单元格,出现更多的线。更重要的是,“三线表”也是一种数据记录规范,以“三线表”形式记录的数...

Python基础语法知识--变量和数据类型

学习Python中的变量和数据类型至关重要,因为它们构成了Python编程的基石。以下是帮助您了解Python中的变量和数据类型的分步指南:1.变量:变量在Python中用于存储数据值。它们充...

一文搞懂 Python 中的所有标点符号

反引号`无任何作用。传说Python3中它被移除是因为和单引号字符'太相似。波浪号~(按位取反符号)~被称为取反或补码运算符。它放在我们想要取反的对象前面。如果放在一个整数n...

Python变量类型和运算符_python中变量的含义

别再被小名词坑哭了:Python新手常犯的那些隐蔽错误,我用同事的真实bug拆给你看我记得有一次和同事张姐一起追查一个看似随机崩溃的脚本,最后发现罪魁祸首竟然是她把变量命名成了list。说实话...

从零开始:深入剖析 Spring Boot3 中配置文件的加载顺序

在当今的互联网软件开发领域,SpringBoot无疑是最为热门和广泛应用的框架之一。它以其强大的功能、便捷的开发体验,极大地提升了开发效率,成为众多开发者构建Web应用程序的首选。而在Spr...

Python中下划线 ‘_’ 的用法,你知道几种

Python中下划线()是一个有特殊含义和用途的符号,它可以用来表示以下几种情况:1在解释器中,下划线(_)表示上一个表达式的值,可以用来进行快速计算或测试。例如:>>>2+...

解锁Shell编程:变量_shell $变量

引言:开启Shell编程大门Shell作为用户与Linux内核之间的桥梁,为我们提供了强大的命令行交互方式。它不仅能执行简单的文件操作、进程管理,还能通过编写脚本实现复杂的自动化任务。无论是...

一文学会Python的变量命名规则!_python的变量命名有哪些要求

目录1.变量的命名原则3.内置函数尽量不要做变量4.删除变量和垃圾回收机制5.结语1.变量的命名原则①由英文字母、_(下划线)、或中文开头②变量名称只能由英文字母、数字、下画线或中文字所组成。③英文字...

更可靠的Rust-语法篇-区分语句/表达式,略览if/loop/while/for

src/main.rs://函数定义fnadd(a:i32,b:i32)->i32{a+b//末尾表达式}fnmain(){leta:i3...

C++第五课:变量的命名规则_c++中变量的命名规则

变量的命名不是想怎么起就怎么起的,而是有一套固定的规则的。具体规则:1.名字要合法:变量名必须是由字母、数字或下划线组成。例如:a,a1,a_1。2.开头不能是数字。例如:可以a1,但不能起1a。3....

Rust编程-核心篇-不安全编程_rust安全性

Unsafe的必要性Rust的所有权系统和类型系统为我们提供了强大的安全保障,但在某些情况下,我们需要突破这些限制来:与C代码交互实现底层系统编程优化性能关键代码实现某些编译器无法验证的安全操作Rus...

探秘 Python 内存管理:背后的神奇机制

在编程的世界里,内存管理就如同幕后的精密操控者,确保程序的高效运行。Python作为一种广泛使用的编程语言,其内存管理机制既巧妙又复杂,为开发者们提供了便利的同时,也展现了强大的底层控制能力。一、P...