Markdown 入门基础

news2024/12/27 13:34:19

文章目录

    • Markdown 是什么?
    • 为什么要使用 Markdown?
    • 工欲善其事,必先利其器
    • Markdown 的工作原理
    • Markdown 有什么用?
      • 网站
      • 文件资料
      • 笔记
      • 书籍
      • 演示文稿
      • 邮件
      • 文档
    • Markdown 方言
    • 其它资源

Markdown 是什么?

Markdown 是一种轻量级的标记语言,可用于在纯文本文档中添加格式化元素。Markdown 由 John Gruber 于 2004 创建,如今已经成为世界上最受欢迎的标记语言之一。

  1. 专注于文字内容;
  2. 纯文本,易读易写,可以方便地纳入版本控制;
  3. 语法简单,没有什么学习成本,能轻松在码字的同时做出美观大方的排版。

使用 Markdown 与使用 Word 类编辑器不同。在 Word 之类的应用程序中,单击按钮以设置单词和短语的格式,并且,更改立即可见。而 Markdown 与此不同,当你创建 Markdown 格式的文件时,可以在文本中添加 Markdown 语法,以指示哪些单词和短语看起来应该有所不同。

例如,要表示标题,只须在短语前添加一个井号即可(例如,# Heading one)。或者要加粗一个短语,只须在短语前后各加两个星号即可(例如,**this text is blod**)。可能需要一段时间才能习惯在文本中看到 Markdown 语法,尤其是你已经习惯了所见即所得的应用程序。以下屏幕截图展示了 Markdown 文件在 [Notepad++ 文本编辑器] 中显示的效果。

你可以用文本编辑器为纯文本文件添加 Markdown 格式的元素。或者,你也可以安装针对 macOS、Windows、Linux、iOS 和 Android 操作系统的 Markdown 应用程序。或者还可以使用一些基于 Web 的应用程序用于 Markdown 编写。

依赖于你所使用的应用程序,你可能无法实时预览格式化的文档。但是没关系。根据 Gruber 的说法,Markdown 的语法被设计为可读性强且不显眼,因此即使 Markdown 文件中的文本未经过渲染也易于阅读。

Markdown 语法的首要设计目标是尽可能易读。基于这个目标,Markdown 格式的文档能够以纯文本形式原样发布,而不会看起来像被填满了标签或格式化指令。

为什么要使用 Markdown?

当你可以通过按下界面中的按钮来设置文本格式时,为什么还要使用 Markdown 来书写呢?使用 Markdown 而不是 Word 类编辑器的原因有:

  • Markdown 无处不在。StackOverflow、CSDN、掘金、简书、GitBook、有道云笔记、V2EX、光谷社区等。主流的代码托管平台,如 GitHub、GitLab、BitBucket、Coding、Gitee 等等,都支持 Markdown 语法,很多开源项目的 README、开发文档、帮助文档、Wiki 等都用 Markdown 写作。
  • Markdown 是纯文本可移植的。几乎可以使用任何应用程序打开包含 Markdown 格式的文本文件。如果你不喜欢当前使用的 Markdown 应用程序了,则可以将 Markdown 文件导入另一个 Markdown 应用程序中。这与 Microsoft Word 等文字处理应用程序形成了鲜明的对比,Microsoft Word 将你的内容锁定在专有文件格式中。
  • Markdown 是独立于平台的。你可以在运行任何操作系统的任何设备上创建 Markdown 格式的文本。
  • Markdown 能适应未来的变化。即使你正在使用的应用程序将来会在某个时候不能使用了,你仍然可以使用文本编辑器读取 Markdown 格式的文本。当涉及需要无限期保存的书籍、大学论文和其他里程碑式的文件时,这是个重要的考虑因素。

工欲善其事,必先利其器

Markdown 入门的最佳方式就是多使用它。由于有大量免费工具的存在,上手 Markdown 是很方便的。比较遗憾的一点是各平台可能采用不同语言实现的 Markdown 解析引擎,或采用同一引擎的不同版本,而且可能有不同程度的定制与扩展,这导致在不同平台上使用的 Markdown 写作时体验并不完全一致。不过幸好对于大家公认的一些标准语法,各家都是支持的。

你甚至都不需要下载任何程序,就可以使用 在线 Markdown 编辑器 来编写 Markdown。进入其站点就可以开始在左侧窗格中书写了。渲染后的文档在右侧窗格预览。

阅读本指南时 ,就可以打开 在线 Markdown 编辑器 。这样,你就可以一边学习 Markdown 语法一边练习了。熟悉 Markdown 之后,再选择一个顺手的 Markdown 的应用程序。

Markdown 的工作原理

在使用 Markdown 格式书写时,文本内容存储在带有 .md.markdown 扩展名的纯文本文件中。那然后呢?你的 Markdown 格式的文件如何转换为 HTML 或可打印的文档呢?

简单来说,你需要一个能够处理 Markdown 文件的 Markdown 应用程序。有许多应用程序可供选择,从简单的脚本到类似于 Microsoft Word 的桌面应用程序。尽管它们在视觉上有所不同,但所有应用程序都执行相同的操作。像 在线 Markdown 编辑器 一样,它们都是将 Markdown 格式的文本转换为 HTML,以便可以在 Web 浏览器中显示。

Markdown 应用程序使用一种称为 Markdown 处理器(也通常称为“解析器”或“实现”)的东西将获取到的 Markdown 格式的文本输出为 HTML 格式。此时,可以在 Web 浏览器中查看你的文档,或者将其与样式表组合并打印。你可以在下图看到此过程的直观表示。

注意: Markdown 应用程序和处理器是两个单独的组件。为了简洁起见,在下图中,我将它们组合为一个元素(即 “Markdown 应用程序”)。

download

总而言之,这是一个四步的过程:

  1. 使用文本编辑器或 Markdown 专用的应用程序创建 Markdown 文件。该文件应带有 .md.markdown 扩展名。
  2. 在 Markdown 应用程序中打开 Markdown 文件。
  3. 使用 Markdown 应用程序将 Markdown 文件转换为 HTML 文档。
  4. 在 Web 浏览器中查看 HTML 文件,或使用 Markdown 应用程序将其转换为其他文件格式,例如 PDF。

从你的角度来看,该过程将根据你使用的应用程序的不同而有所不同。例如,在线 Markdown 编辑器 本质上将第 1-3 步组合到一个单一、无缝的界面中,你要做的就是在左窗格中键入内容,然后转换结果就在右窗格中神奇地出现了。但是,如果你使用的是其他工具(例如带有静态网站生成器的文本编辑器),则会发现该过程更为明显。

Markdown 有什么用?

Markdown 是做笔记、为网站创建内容以及生成可打印文档的快速、简便的方法。

学习 Markdown 语法并不需要很长时间,一旦你知道如何使用它,你就可以在几乎所有地方使用 Markdown 进行书写了。大多数人使用 Markdown 来为网站创建内容,但是 Markdown 也可以很好地格式化从电子邮件到购物清单的所有内容。

下面是一些你可以使用 Markdown 的场景。

网站

Markdown 是为 Web 而设计的,因此,市面上有很多专门用于创建网站内容的应用程序就不足为奇了。

如果您熟悉 HTML、CSS和版本管理工具,请试试 [Jekyll],这是一个广受欢迎的静态网站生成器,它能将 Markdown 文件构建为 HTML 网站。这种方法的优势之一是 [GitHub Pages] 为 Jekyll 生成的网站提供免费托管服务。

如果 Jekyll 不是你的理想之选,如果你是 WordPress 博主,你可以使用 Jetpack 插件 实现对 Markdown 的支持。

文件资料

Markdown 并不具备像 Microsoft Word 这样的文字处理程序的所有功能,但是对于创建基本文件(例如作业和信件)来说已经足够了。你可以使用 Markdown 文档创作工具来创建 Markdown 格式的文档并将其导出为 PDF 或 HTML 格式。PDF 格式是关键,因为一旦有了 PDF 文档,您就可以使用它进行任何操作:打印、通过电子邮件发送或将其上传到网站。

这是我推荐的一些 Markdown 文档创作工具:

  • 现代编辑器
    VSCode / Atom
  • 传统编辑器
    Vim / Emacs / Sublime Text / Notepad++
  • IDE 自带编辑器
    IntelliJ IDEA / Android Studio / WebStorm
  • 专用编辑器
    Ulysses / Mou / Typora / Markpad
  • 在线编辑器
    各种支持 Markdown 的网站都提供了在线 Markdown 编辑器

笔记

在几乎所有方面,Markdown 都是记笔记的理想语法。不幸的是,两个最受欢迎的笔记应用程序 Evernote 和 OneNote 目前都不支持 Markdown。好消息是,其他一些笔记应用程序 支持 Markdown 的:

  • [Simplenote] 是适用于所有平台的免费、简单的笔记应用程序。
  • [Notable] 是可以在各种平台上运行的笔记应用程序。
  • [Bear] 是适用于 Mac 和 iOS 设备的类似 Evernote 的应用程序。默认情况下,它并不专门针对 Markdown 的,但是你可以启用 Markdown 兼容模式。
  • [Boostnote] 自称是“专为程序员设计的开源笔记应用程序”。

如果你无法放弃 Evernote,可以试试 Marxico,一个专门针对 Evernote 的基于订阅付费的 Markdown编辑器,或在 Evernote 网站上使用 [Markdown Here] 插件。

书籍

想要自行出版小说?请试试 Leanpub,该服务可将你的 Markdown 格式的文件转换为电子书。Leanpub 以 PDF、EPUB 和 MOBI 文件格式输出你的图书。如果你要创建纸版书籍,可以将 PDF 文件上传到类似 Kindle Direct Publishing 之类的服务提供商处。要了解有关使用 Markdown 编写和自行出版书籍的更多信息,请阅读 此博文。

演示文稿

信不信由你,你可以将 Markdown 格式的文件转换成演示文稿。在 Markdown 中创建演示文稿需要一点时间来适应,但是一旦你掌握了它,你就能体会到比使用 PowerPoint 或 Keynote 之类的应用程序更快、更容易。Remark(GitHub 仓库)和 Cleaver(GitHub 仓库)一样,是一种基于浏览器的、流行的 Markdown 幻灯片工具。如果你使用的是 Mac,并且希望安装一个应用程序来使用的话,请试试 Deckset 或 Marked。

邮件

如果你需要发送大量电子邮件,并且对大多数电子邮件提供商网站上可用的格式设置控件感到厌倦,那么你将很高兴地发现有一种使用 Markdown 编写电子邮件的简便方法:[Markdown Here] 是一个免费、开源的浏览器扩展程序,可将 Markdown 格式的文本转换为可用于发送的 HTML。

文档

Markdown 非常适合技术文档。像 GitHub 这样的公司越来越多地转向使用 Markdown 来创建其文档了,请查看此 博文 以了解如何将 Markdown 格式的文档迁移到 [Jekyll]。如果你是为产品或服务编写文档,请试试以下的便捷工具:

  • Read the Docs 可以将你所开源的 Markdown 文件生成文档网站。只需将你的 GitHub 仓库连接到他们的服务,然后你就可以将内容推送到该仓库中,Read the Docs 会完成其余的工作。他们还为 商业实体提供服务。
  • [MkDocs] 是一个快速、简单的静态站点生成器,专门用于构建项目文档。文档源文件使用 Markdown 编写,并使用一个 YAML 配置文件进行配置。MkDocs 有多个 内置主题,包括移植自 Read the Docs 的文档主题。最新的一个主题是 MkDocs Material。
  • [Docusaurus] 是一个静态网站生成器,专门用于创建文档网站。它支持翻译、搜索和版本控制。
  • VuePress 是基于 Vue 构建的静态站点生成器,并针对编写技术文档进行了优化。
  • [Jekyll] 前面已经提到过它了,但它也是将 Markdown 文件生成文档网站的一个不错的选择。如果你选择 Jekyll,请务必试试 Jekyll 文档主题。

Markdown 方言

使用 Markdown 的过程中,最令人困惑的地方是:实际上每个 Markdown 应用程序都实现了稍有不同的 Markdown 语法。Markdown 的这些变体通常被称为 flavors(方言)。掌握你的应用程序所实现的 Markdown 语法是你需要注意的。

为了让你了解各 Markdown 变体的概念,将它们比作语言的方言(language dialects)可能会有所帮助。华雷斯城(Ciudad Juárez)的人说西班牙语,就像巴塞罗那(Barcelona)人一样,但是两个城市使用的方言之间有很大的不同。使用不同 Markdown 应用程序的人也是如此。Dillinger 支持的 Markdown 格式与 Ulysses 有着很大的不同。

实际上,这意味着当一个应用程序说它支持 “Markdown” 时,你永远也不会确切地知到它的实际意思。它说的是仅支持 基本语法?还是所有基本语法加 扩展语法 ?或者是某些语法的组合呢?在你阅读其文档或开始使用该应用程序之前,你永远都不会知道。

如果你只是新手,我能给你的最好建议就是选择一个具有良好 Markdown 支持的应用程序。这对保持 Markdown 文件的可移植性大有帮助。你可能需要在其它应用程序中保存或使用你的 Markdown 文件,要实现这一点,你应当从使用一个具有良好 Markdown 支持的应用程序开始。你可以在 Markdown 工具列表 中找到合适的应用程序。

其它资源

网上有很多资源用来学习 Markdown。以下列出一些:

  • John Gruber’s Markdown documentation. Markdown 的创建者编写的原始指南。
  • Markdown Tutorial. 一个开源网站,你能用浏览器在这个网站上尝试 Markdown。
  • Awesome Markdown. Markdown 工具和学习资源列表。
  • Typesetting Markdown. 这是一个系列教程,介绍了使用 pandoc 和 ConTeXt 对 Markdown 文档进行排版的系统。

本作品采用 知识共享署名 4.0 国际许可协议 进行许可。
本文链接:

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

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

相关文章

【Docker报错】docker拉取镜像时报错:no such host

报错信息 [rootSoft soft]# docker pull mysql Using default tag: latest Error response from daemon: Head "https://registry-1.docker.io/v2/library/mysql/manifests/latest": dial tcp: lookup registry-1.docker.io on 192.168.80.2:53: no such host解决方法…

ogg格式怎么转换为mp3?

ogg格式怎么转换为mp3?我们都知道,OGG格式作为一种数字饮片格式,使用的是有损压缩技术,从而也保证了文件音质较高。然而,也正是因为这个特点,导致OGG格式文件较大。很多时候,我们在使用OGG格式文…

内网穿透-外远程连接中的RabbitMQ服务

文章目录 前言1.安装erlang 语言2.安装rabbitMQ3. 内网穿透3.1 安装cpolar内网穿透(支持一键自动安装脚本)3.2 创建HTTP隧道 4. 公网远程连接5.固定公网TCP地址5.1 保留一个固定的公网TCP端口地址5.2 配置固定公网TCP端口地址 前言 RabbitMQ是一个在 AMQP(高级消息队列协议)基…

日志系统——日志格式化模块设计

一,模块主要成员 该模块的主要作用是对日志消息进行格式化,将日志消息组织成制定格式的字符串。 该模块主要成员有两个:1.格式化字符串。 2.格式化子项数组 1.1 格式化字符串 格式化字符串的主要功能是保存日志输出的格式字符串。其格式化字…

网络安全/黑客技术(就业前景与经验分享)

网络安全与我们每一个人都息息相关,无论是企业还是个人,现在都非常重视网络安全。而且网络安全是一个新兴的行业,人才需求量远远大于供给,所以在薪资福利上具有很大的优势,并且对于初学者而言,很多人依旧担…

ThreadPool线程池

文章目录 一.概述和架构二.使用方式和底层原理三.七个参数介绍四.工作流程和拒绝策略五.自定义线程池 一.概述和架构 一种线程使用模式。线程过多会带来调度开销,进而影响缓存局部性和整体性能,而线程池维护着多个线程,等待着监督管理者分配可并发执行的任务,这避免了在短时间…

文件名称是递增的,删除掉其中一部分的文件,导致递增文件缺少,通过python查找出缺少的递增文件名称

文件名称是递增的,删除掉其中一部分的文件,导致递增文件缺少,通过python查找出缺少的递增文件名称 通过python,查找出缺少的递增的文件的名称: 代码如下: import osdef find_missing_numbers(folder_path):file_list …

6000万美元?通用汽车投资初创新贵Mitra,开发“经济型电池”

根据最新消息,通用汽车公司日前宣布领导一轮6000万美元的B轮融资,投资对象为电池材料初创公司Mitra Chem。此次投资旨在帮助通用汽车改进未来电动汽车的电池制造,使其更加经济实惠且易获取。 目前,大多数电池使用的是镍和钴的制造…

linux系统--makefile文件,gdb 以及文件描述符

目录 1 makefile 1.1 makefile的基本规则 1.2 makefile工作原理 1.3 makefile中的变量 1.4 makefile函数 1.5 makefile的清理操作 2 gdb调试 2.1 gdb介绍 2.2 生成调试信息 2.3 启动gdb 2.4 显示源代码 3文件IO 3.1 C库IO函数的工作流程 3.2 C库函数与系统函数的…

Sigmastar SSC8826Q 2K行车记录仪解决方案

一、方案描述 行车记录仪是智能辅助汽车驾驶,和管理行车生活的车联网智能终端设备,利用智能芯片处理器、GPS定位、网络通信、自动控制等技术,将与行车生活有关的各项数据有机地结合在一起。 行车记录仪如今已经成了必不可少的车载用品之一&…

用栈解决有效的括号匹配问题

//用数组实现栈 typedef char DataType; typedef struct stack {DataType* a;//动态数组int top;//栈顶int capacity; //容量 }ST;void STInit(ST*pst);//初始化void STDestroy(ST* pst);//销毁所有空间void STPush(ST* pst, DataType x);//插入数据到栈中void STPop(ST* pst);…

开学有什么平替电容笔值得买?比较好用的ipad手写笔

相信不少的学生党都已经在开学前入手了iPad,而现在,电容笔作为iPad的一种主要配件,其的性能也在不断地提高,使用电容笔的用户也在不断地增加。因此,如何挑选一款物美价廉的电容笔成为大家最关心的问题。那么&#xff0…

C/C++ : C/C++的详解,C语言与C++的常用算法以及算法的各自用法和应用(初级,中级),C++ CSP考题(J居多,S偏少)的详解,NOI的真题题解

目录 1.C语言 2.C 3.C与C语言的共同/不同点 4.导读 5.相关文章 5.1:Dev-C是Windows 环境下的一个轻量级 C/C 集成开发环境(IDE) 5.2:C是从C语言发展而来的,而C语言的历史可以追溯到1969年 6.C/C最新年度总…

java编译报错,get方法报错

java编译报错,get方法报错 处理方式: 在空间中,将 buid 文件夹删除 再不行的话,重启电脑,删除各种缓存 试试

Java请求Http接口-OkHttp(超详细-附带工具类)

简介:OkHttp是一个默认有效的HTTP客户端,有效地执行HTTP可以加快您的负载并节省带宽,如果您的服务有多个IP地址,如果第一次连接失败,OkHttp将尝试备用地址。这对于IPv4 IPv6和冗余数据中心中托管的服务是必需的。OkHt…

【boost网络库从青铜到王者】第五篇:asio网络编程中的同步读写的客户端和服务器示例

文章目录 1、简介2、客户端设计3、服务器设计3.1、session函数3.2、StartListen函数3、总体设计 4、效果测试5、遇到的问题5.1、服务器遇到的问题5.1.1、不用显示调用bind绑定和listen监听函数5.1.2、出现 Error occured!Error code : 10009 .Message: 提供的文件句柄无效。 [s…

docker限制容器日志大小

文章目录 业务场景问题排查彻底解决 业务场景 我们公司做交通相关业务,我们部门主要负责信控服务,卖信号机的硬件产品和配套的信控平台 由于有部分小项目,可能只有几十个路口,客户预算有限,只给我们老旧的Windows ser…

Google浏览器点击链接打开新标签页

由于新安装的谷歌浏览器点击链接时默认在当前窗口打开非常不方便,这里提供一下解决思路 1、打开浏览器输入任意内容,点击右上角的设置 2、在弹出的选项栏中点击See all Search settings 3、点击Other settings,将指定选项打开即可

数据结构——二叉搜索树

本章代码:二叉搜索树 文章目录 🌲1.二叉搜索树概念🌳2. 二叉搜索树操作🌿2.1 结构定义🌿2.2 插入操作🌿2.3 查找操作🌿2.4 删除操作🌿2.5 遍历 🌴3. 二叉搜索树应用场景&#x1f340…

[JavaWeb]【五】web后端开发-Tomcat SpringBoot解析

目录 一 介绍Tomcat 二 基本使用 2.1 解压绿色版 2.2 启动TOMCAT 2.3 关闭TOMCAT 2.4 常见问题 2.5 修改端口号 2.6 部署应用程序 三 SpringBootWeb入门程序解析 前言:tomcat与SpringBoot解析 一 介绍Tomcat 二 基本使用 2.1 解压绿色版 2.2 启动TOMCAT 2…