jjzjj

MarkDown在VSCode环境下使用

LLyyxxx00 2024-05-02 原文

目录

1.MarkDown简介

2.VSCode简介(Visual Studio Code)

3.VSCode中的MarkDown环境

4.MarkDown相关操作与常用语法

(1)创建新.md文件

(2)标题

(3)换行与分段

(4)强调(加粗与斜体)

(5)列表(有序&无序) 

(6)插入图片

(7)数学公式

(8)表格

(9)链接

(10)代码块

(11)分割线

(12)引用

(13)流程图

(14)目录

(15)md文件导出为其他文件


1.MarkDown简介

Markdown 是一种轻量级标记语言,一个运行于 Mac OS XWindows Linux 之上的,针对于编写现代Web云应用的跨平台源代码编辑器

Markdown文件后缀名为 .md

        优点:

  • 轻量化、易读易写
  • 对于图片,图表、数学式都有支持
  • 许多网站都广泛使用 Markdown 来撰写文档
  • 使用标记语言语法编排文档,简洁明了
  • Markdown可以快速转化为演讲PPT、Word、PDF等产品文档
  • 可用于编写说明文档,以“README.md”的文件名保存在软件的目录下面

2.VSCode简介(Visual Studio Code)

Visual Studio Code(简称“VS Code”)是Microsoft在2015年4月30日Build开发者大会上正式宣布一个运行于 Mac OS XWindows Linux 之上的,针对于编写现代Web云应用的跨平台源代码编辑器

不仅仅是源代码编辑器,Visual Studio Code已经成为当前最热门的文本编辑器。

        优点:

  • 跨平台
  • 开源
  • 简易
  • 可扩展,插件丰富
  • 轻量快捷

3.VSCode中的MarkDown环境

需先安装VSCode

在VSCode插件商店中搜索并安装以下插件:

  • Markdown All in One   ——提供丰富的Markdown相关的快捷键、自动补全功能,提高md文档编写生产力
  • Markdown Preview Ehanced   ——用于渲染当前编写文档的效果同步预览
  • Paste Image   ——用于快速引用图片至Markdown文档

        注意:安装完Markdown Preview Ehanced 可能会发生markdown换行相关语法错误以下为解决办法:

下载好所有插件重启生效后,需要修改一下设置,点击左下角齿轮按钮,在搜索框中输入break,将搜索选项中的Markdown Preview Ehanced:Break On Single New Line取消勾选。

以下为取消勾选操作完成图:

4.MarkDown相关操作与常用语法

(1)创建新.md文件

在左侧文件夹内创建新的文件并后缀命名为.md,并点击右上角预览按钮同步渲染文本效果

(2)标题

在想要设为标题的文本前进加井号“#”,一级标题加1个“#”,二级加2个,最多为6级

正文则直接写就好

效果如下:

(3)换行与分段

在MD中,回车并不能换行,只是将文字加个空格,如下左侧编辑器中回车换行,但右侧渲染出来的效果只是空了一格:

 想要换行需要在上一行后面加两个空格再回车

如果要新起一段,则打两个回车

(4)强调(加粗与斜体)

斜体:在文本两端各加1个星号”*“        快捷键:ctrl + i

加粗:在文本两端各加2个星号”*“        快捷键:ctrl + b

 

(5)列表(有序&无序) 

有序列表:输入1.加一个空格(注意有点”.“),按回车会自动补全编号

如果要输入分级列表,回车并删除新生成的序列号并再次输入1.空格

如果要加入新的列表则在两个列表之间新起一段,或者添加文字

无序列表:输入星号"*"加空格或者加号"+"加空格或者减号"-"加空格

(6)插入图片

复制所需图片,在所需插入图片位置按下快捷键ctrl+alt+v(不是ctrl+v噢),效果如下:

或者手动把图片加入md文件所在文件夹下,输入 ![](图片文件名)

(7)数学公式

以下采用latex排版方式对数学公式进行演示,数学公式以 ”\“ 起始

行内展示数学公式:用1个$$括起来            快捷键:ctrl+m

另起一段展示数学公式:用两个$$括起来   快捷键:连按两下ctrl+m

 

(8)表格

第一行是表头以”|“区分列

第二行是对齐方式, "-"表示默认对其即左对齐,在"-"左侧加":"为左对齐,在右侧加":"为右对齐,两边都加":"为剧中对齐("-"的个数可随便写,按照自己的喜好对齐即可,冒号一定要是英文字符!!!)

 按下alt+shift+f 可格式化文本编排,效果如下:

(9)链接

复制链接ctrl+v黏贴

直接黏贴则直接生成可点击的链接

选中文字黏贴则生成可点击的文字按钮链接

(10)代码块

用两行"```"括起来,键盘左上方Tab键上方的点号,英文输入法下输入!!

在第一行"```"后输入所用语言名字可指定语言提供高亮,如:

```javascript

```

(11)分割线

在所需添加分割线的文本下新起一行输入三个减号 "---"

(12)引用

 在引用的文字前加上大于号">",如下:

(13)流程图

运用flowchart.js语法

基本语法:tag=>type: content:>url

  • tag        元素名字,可自定义
  • type      元素类型
  • url         引用的链接,点击相应元素可出发链接

注意:冒号和名称之间需要有一个空格

相关元素类型:

  • 开始(椭圆形):start
  • 结束(椭圆形):end
  • 结束(椭圆形):end
  • 多输出操作(矩形):parallel
  • 条件判断(菱形):condition
  • 输入输出(平行四边形):inputoutput
  • 预处理/子程序(圣旨形):subroutine
  • content就是在框框中要写的内容,注意type后的冒号与文本之间一定要有个空格。
  • url是一个连接,与框框中的文本相绑定

关键字

  • yes/true:condition类型变量连接时,用于分别表示yes条件的流向
  • no/false:同上,表示否定条件的流向
  • left/right:表示连线出口在节点位置(默认下面是出口,如op3),可以跟condition变量一起用:cond(yes,right)
  • path1/path2/path3:parallel变量的三个出口路径(默认下面是出口)

节点状态

  为节点设置不同的状态,可以通过不同的颜色显示,其中状态包括下面6个,含义如英文所示,

  • past
  • current
  • future
  • approved
  • rejected
  • invalid

以下是示例:

```flow
st=>start: 开始
e=>end: 结束
tag1=>operation: 任务1
tag2=>operation: 任务2
cond1=>condition: 是否进行任务2

st->tag1(right)->cond1
cond1(no)->tag1
cond1(yes)->tag2
tag2->e
```

(14)目录

在要生成目录的地方输入 [TOC] ,markdown或根据分级标题自动生成目录

 

(15)md文件导出为其他文件

点击markdown preview ehanced提供的渲染预览按钮(使用这个渲染方式下导出的文件数学公式比较可靠乱码概率较小)(鼠标移植按钮上方提示markdown preview ehanced相关或者MPE相关)

如果只有看见一个预览按钮,那就是markdown preview ehanced隐藏了vscode自带的markdown文档预览按钮,所以只显示了一个markdown preview ehanced的预览按钮,直接用就好。

若想恢复vscode自带的markdown文档预览按钮,则点击左下角齿轮按钮进入设置,搜索"Hide Default VSCode Markdown Preview Buttons"取消勾选即可,如下为恢复状态:

在预览界面中右键,选择谷歌浏览器导出为PDF

有关MarkDown在VSCode环境下使用的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri,根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

    我有一个Ruby程序,它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重,我想提高压缩级别,因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗?是否有另一个允许指定压缩级别的Ruby库? 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

  3. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法? - 2

    类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

  4. ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2

    很好奇,就使用ruby​​onrails自动化单元测试而言,你们正在做什么?您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您?git中的预提交Hook?只是手动调用?我完全理解测试,但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的,并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您? 最佳答案 不确定您到底想听什么,但是有几个级别的自动代码库控制:在处理某项功能时,您可以使用类似autotest的内容获得关于哪些有效,哪些无效的即时反馈。要确保您的提

  5. ruby - 在 Ruby 中使用匿名模块 - 2

    假设我做了一个模块如下:m=Module.newdoclassCendend三个问题:除了对m的引用之外,还有什么方法可以访问C和m中的其他内容?我可以在创建匿名模块后为其命名吗(就像我输入“module...”一样)?如何在使用完匿名模块后将其删除,使其定义的常量不再存在? 最佳答案 三个答案:是的,使用ObjectSpace.此代码使c引用你的类(class)C不引用m:c=nilObjectSpace.each_object{|obj|c=objif(Class===objandobj.name=~/::C$/)}当然这取决于

  6. ruby - 使用 ruby​​ 和 savon 的 SOAP 服务 - 2

    我正在尝试使用ruby​​和Savon来使用网络服务。测试服务为http://www.webservicex.net/WS/WSDetails.aspx?WSID=9&CATID=2require'rubygems'require'savon'client=Savon::Client.new"http://www.webservicex.net/stockquote.asmx?WSDL"client.get_quotedo|soap|soap.body={:symbol=>"AAPL"}end返回SOAP异常。检查soap信封,在我看来soap请求没有正确的命名空间。任何人都可以建议我

  7. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声? - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点?我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等),但我确实想创建一个输出文件。

  8. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

    我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗?当我运行compasswatch时,它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行?文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们?我自己编译的.sass文件编译成compiled/t

  9. ruby - 使用 ruby​​ 将 HTML 转换为纯文本并维护结构/格式 - 2

    我想将html转换为纯文本。不过,我不想只删除标签,我想智能地保留尽可能多的格式。为插入换行符标签,检测段落并格式化它们等。输入非常简单,通常是格式良好的html(不是整个文档,只是一堆内容,通常没有anchor或图像)。我可以将几个正则表达式放在一起,让我达到80%,但我认为可能有一些现有的解决方案更智能。 最佳答案 首先,不要尝试为此使用正则表达式。很有可能你会想出一个脆弱/脆弱的解决方案,它会随着HTML的变化而崩溃,或者很难管理和维护。您可以使用Nokogiri快速解析HTML并提取文本:require'nokogiri'h

  10. ruby - 在 64 位 Snow Leopard 上使用 rvm、postgres 9.0、ruby 1.9.2-p136 安装 pg gem 时出现问题 - 2

    我想为Heroku构建一个Rails3应用程序。他们使用Postgres作为他们的数据库,所以我通过MacPorts安装了postgres9.0。现在我需要一个postgresgem并且共识是出于性能原因你想要pggem。但是我对我得到的错误感到非常困惑当我尝试在rvm下通过geminstall安装pg时。我已经非常明确地指定了所有postgres目录的位置可以找到但仍然无法完成安装:$envARCHFLAGS='-archx86_64'geminstallpg--\--with-pg-config=/opt/local/var/db/postgresql90/defaultdb/po

随机推荐