paint-brush
Markdown 初学者指南:入门所需了解的一切经过@odafetoearth
1,441 讀數
1,441 讀數

Markdown 初学者指南:入门所需了解的一切

经过 Odafe Alaiya 8m2023/08/28
Read on Terminal Reader

太長; 讀書

如果您是 Markdown 领域的新手,请不要害怕;本指南旨在成为您掌握这种用户友好的标记语言之旅的指南针。
featured image - Markdown 初学者指南:入门所需了解的一切
Odafe Alaiya  HackerNoon profile picture
0-item

目录

  • 什么是 Markdown?
    • 使用 Markdown 的优点
  • 开始使用 Markdown
    • Markdown 中的基本格式
    • Markdown 中的高级格式
  • Markdown 的实际应用
  • 资源


无论您从事哪个行业,清晰简洁地表达您的想法和想法的能力都很重要。幸运的是,有许多工具和技术可以帮助您制作良好的文本内容。


Markdown 是一种多功能但不起眼的标记语言,已成为各种作家、程序员和内容创作者的主要工具。


如果您是 Markdown 领域的新手,请不要害怕;本指南旨在成为您掌握这种用户友好的标记语言之旅的指南针。

什么是 Markdown?

Markdown 是一种轻量级标记语言,可简化网络和其他媒体文本格式化的过程。它由 John Gruber 和 Aaron Swartz 于 2004 年创建,作为一种编写可以轻松转换为 HTML 和其他格式的内容的方法,而无需广泛的技术知识。


它在作家、博主、程序员以及任何需要简单有效的方法来格式化网络文本的人中特别受欢迎。

使用 Markdown 的优点

1. 简单性和可读性: Markdown 使用纯文本字符的简单语法。这种简单性使其易于学习和使用,使您能够专注于内容本身而不是复杂的格式化代码。


2. 平台无关: Markdown 是平台无关的。您可以使用文本编辑器或代码编辑器在任何设备上创建 Markdown 文档,并且可以在不同平台上轻松查看这些文档并将其转换为各种格式。这种一致性确保了您的内容的可访问性和寿命。


3.快速学习曲线: Markdown 具有最简单的语法之一。这意味着您可以在短时间内学会它。语法很直观,类似于您可能已在电子邮件或短信中使用的格式。


这种快速学习曲线鼓励非技术用户采用。


4.广泛采用: Markdown 已经获得了巨大的普及,并受到多种平台的支持,包括 WordPress 等博客系统、GitHub 等协作工具和内容管理系统。这使得 Markdown 成为一项可以在许多情况下应用的宝贵技能。


5. 速度和效率:在 Markdown 中创建内容快速且高效。使用一些简单的字符和其他格式元素。作为回报,用户可以简单、高效、快速地制作文档。


6.版本控制:当将 Markdown 与 Git 等版本控制系统配合使用时,对 Markdown 文件所做的更改很容易跟踪。这使得项目协作、审查更改和维护清晰的编辑记录变得更加简单。

开始使用 Markdown

Markdown 适用于各种文本编辑器和代码编辑器。在本文中,我们将重点关注在代码编辑器中使用 Markdown,特别是VS Code 。不过,在文本编辑器中可以遵循相同的语法。


  1. 首先,在 VS Code 中创建一个文件夹(您可以随意命名)。在该文件夹中,创建一个名为markdown.md的文件


  2. 导航到 VS Code 文件的右上角部分,然后单击预览按钮以并排预览结果。

Markdown 中的基本格式

以下是在 Markdown 中格式化文本的一些基本语法。


  1. 标题:标题用于指示文档中不同级别的标题。要在 Markdown 中创建标题,请使用#符号,后跟一个空格,然后是标题文本。请注意, #符号的数量决定了标题的级别。请参阅下面的示例。

     # Heading ## Heading ### Heading 

2. 强调:您可以通过将文本设为粗体或斜体来强调文本。要使文本加粗,请将其括在双星号**或双下划线__中。要使文本变为斜体,请将其括在单个星号*或单个下划线_中。


例子:

 This is the **Bold Text** This is *italics* 

3. 列表: Markdown 支持有序(编号)和无序列(项目符号)列表。要创建有序列表,请以数字开头,后跟句点。要创建无序列表,请使用星号* 、加号+或连字符-


例子:

 Ordered List: 1. First item 2. Second item 3. Third item Unordered List: * Item 1 * Item 2 * Item 3 

4. 链接:您可以在 Markdown 中创建超链接,使用方括号[]作为链接文本,使用圆括号()作为链接 URL。


例子:

 [Visit Odafe's Website](https://www.odafe.vercel.app)


5. 图片:插入图片与创建链接类似;唯一的区别就是一个感叹号!在方括号前面。方括号中的替代文本用于描述图像以方便访问。


例子:

 ![Alt text](image-url.jpg)


6. 引用块:引用块用于显示引用文本。要创建它,只需以>符号开始行,后跟要引用的文本。


例子:

 > This is a quote by Odafe


输出如下所示:


这是奥达菲的一句话


7. 水平规则:只需使用三个下划线_即可添加水平分隔符。


例子:

 This is a regular text ____ This is more regular text 

这些是 Markdown 基本格式的基本元素。通过掌握这些概念,无论您是编写简单的笔记还是制作更复杂的文档,您都将能够创建结构良好且具有视觉吸引力的内容。

Markdown 中的高级格式

如果您可能需要向文档添加更复杂的元素,Markdown 还提供了附加功能。其中一些格式选项是:


1. 代码块和内联代码:您可以轻松地将代码块添加到文件中,方法是用三个反引号 (```) 开始代码块,后跟编写代码块所用的语言。内联代码是通过包装代码片段来添加的在单个反引号中。


例子:

 This is a HTML element `<div>Hello World</div>` ```javascript function myFunction() { console.log("Hello world!") } 

2. 任务列表:任务列表对于创建待办事项列表很有用。要创建任务列表,请使用方括号,其中“x”表示已完成的任务,空格表示未完成的任务。


例子:

 - [x] A complete task - [ ] An incomplete task 

3. 表情符号:有两种方法可以将表情符号添加到 Markdown 文件中:将表情符号复制并粘贴到 Markdown 格式的文本中或输入表情符号短代码


4. 删除文本:要删除文本,请在要删除的文本周围使用双波形符 ( ~~ )。


例子:

 This is a ~~Strikethrough~~ text.


5.转义字符:如果需要显示Markdown中具有特殊含义的字符,可以使用反斜杠( \ )对其进行转义。

 To display a literal asterisk \* use a backslash before it.


6. 上标和下标:要创建上标,上标文本要用两个^符号括起来。


要创建下标文本,请将文本包裹在两个~符号中。


例子:

 This is how a superscript is written: X^2^ This is how a subscript is written: H~2~O. 

7. 表格:要在 Markdown 中创建表格,请按照下列步骤操作:


  • 每行以管道符号 ( | ) 开始和结束。
  • 使用管道符号 ( | ) 分隔每列。
  • 使用三个或更多连字符 ( --- ) 创建列标题。
 | Syntax | Description | | ----------- | ----------- | | Header | Title | | Paragraph | Text |


输出:


8. 突出显示:您可以通过在单词前后使用两个等号( == )来突出显示文档中的重要单词。


例子:

 This highlighted word is ==Bee==


输出:




9. 脚注:脚注是在文档末尾添加注释和参考文献而不会使正文混乱的一种方式。要创建脚注引用,请在括号 ( [^1] ) 内添加插入符号 ( ^ ) 和唯一标识符(通常是数字或单词)。


标识符不能包含空格或制表符。在输出中,脚注按顺序编号。


例子:


 This is an example sentence with a footnote[^1]. [^1]: This is the content of the footnote.


输出:


您可以在此处了解有关 Markdown 中的高级格式设置的更多信息。


Markdown 的实际应用

Markdown 在软件开发人员和编程社区中广受欢迎。值得注意的是,它在版本控制平台中发挥着关键作用,作为解释代码库本质的全面且可访问的手段。


通过使用 Markdown 作为描述复杂代码的渠道,开发人员创建了清晰度和上下文的和谐融合。


这种做法向那些偶然发现代码存储库的人伸出了援助之手,有助于快速而深刻地掌握项目的总体目的和细微差别。


通过这种方式,Markdown 不仅是一种格式化工具,而且是一种强大的沟通工具,弥合了复杂的编码工作与其深刻的现实世界含义之间的差距。

结论

请记住,Markdown 不仅仅是一个工具;更是一个工具。它是一座将您的想法与全球受众联系起来的桥梁,使您的声音能够清晰而富有影响力地被听到。


它与各种平台的兼容性、简单性和适应性确保您的 Markdown 之旅不局限于本指南,而是随着您探索表达自己和想法的新方式而继续。

资源

谢谢


也发布在这里