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

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

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

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/

相关推荐

Chinese vice premier calls for multilateralism at Davos

DAVOS,Switzerland,Jan.21(Xinhua)--ChineseVicePremierDingXuexiangdeliveredaspeechatthe...

用C++ Qt手把手打造炫酷汽车仪表盘

一、项目背景与核心价值在车载HMI(人机交互界面)开发领域,虚拟仪表盘是智能座舱的核心组件。本项目基于C++Qt框架实现一个具备专业级效果的时速表模块,涵盖以下技术要点:Qt图形绘制核心机制(QPa...

系列专栏(八):JS的第七种基本类型Symbols

ES6作为新一代JavaScript标准,已正式与广大前端开发者见面。为了让大家对ES6的诸多新特性有更深入的了解,MozillaWeb开发者博客推出了《ES6InDepth》系列文章。CSDN...

MFC界面开发工具BCG v31.1 - 增强功能区、工具箱功能

点击“了解更多”获取工具亲爱的BCGSoft用户,我们非常高兴地宣布BCGControlBarProfessionalforMFC和BCGSuiteforMFCv31.2正式发布!新版本支...

雅居乐上调出售吉隆坡项目保留金,预计亏损扩大至6.64亿元

1月2日,雅居乐集团(03383.HK)发布有关出售一家附属公司股权披露交易的补充公告。此前雅居乐集团曾公告,2023年11月8日(交易时段后),集团子公司AgileRealEstateDeve...

Full text: Address by Vice Premier Ding Xuexiang's at World Economic Forum Annual Meeting 2025

DAVOS,Switzerland,Jan.21(Xinhua)--ChineseVicePremierDingXuexiangonTuesdaydeliveredasp...

手机性能好不好 GPU玄学曲线告诉你

前言各位在看测试者对手机进行评测时或许会见过“安卓玄学曲线”,所谓中的安卓玄学曲线真名为“ProfileGPURendering”。大多数情况下,在系统“开发者选项中被称为“GPU显示配置文件”或...

小迈科技 X Hologres:高可用的百亿级广告实时数仓建设

通过本文,我们将会介绍小迈科技如何通过Hologres搭建高可用的实时数仓。一、业务介绍小迈科技成立于2015年1月,是一家致力以数字化领先为优势,实现业务高质量自增长的移动互联网科技公司。始...

vue3新特征和所有的属性,方法汇总及其对应源码分析

vue3新特征汇总与源码分析(备注:vue3使用typescript编写)何为应用?constapp=Vue.createApp({})app就是一个应用。应用的配置和应用的API就是app应用...

China's stability redefines global trade in a volatile era

ContainersareunloadedatQingdaoPort,eastChina'sShandongProvince,December10,2024.[Photo/X...

QML 实现图片帧渐隐渐显轮播

前言所谓图片帧渐隐渐显轮播就是,一组图片列表,当前图片逐渐改变透明度隐藏,同时下一张图片逐渐改变透明度显示,依次循环,达到渐隐渐显的效果,该效果常用于图片展示,相比左右自动切换的轮播方式来说,这种方式...

前端惊魂夜:我竟在CSS里写出了JavaScript?

凌晨两点,写字楼里只剩下我工位上的一盏孤灯。咖啡杯见底,屏幕的光映在疲惫的眼镜片上。为了实现一个极其复杂的动态渐变效果,我翻遍了MDN文档,试遍了所有已知的CSS技巧,却始终差那么一口气。“要是CSS...

10 个派上用场的 Flutter 小部件

尝试学习一门新语言可能会令人恐惧和厌烦。很多时候,我们希望我们知道早先存在的某些功能。在今天的文章中,我将告诉你我希望早点知道的最方便的颤振小部件。SpacerSpacer创建一个可调整的空白空...

让我的 Flutter 代码整洁 10 倍的 5 种

如果你曾在Flutter中使用过SingleTickerProviderStateMixin来制作动画,猜猜怎么着?你已经使用过Mixin了——恭喜你,你已经处于一段你甚至不知道的关...

daisyUI - 主题漂亮、代码纯净!免费开源的 Tailwind CSS 组件库

漂亮有特色的CSS组件库,组件代码非常简洁,也支持深度定制主题、定制组件,可以搭配Vue/React等框架使用。关于daisyUIdaisyUI是一款极为流行的CSSUI组件库,...