1 Star 0 Fork 0

qtmd/qtmd-viewer-vscode

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README

QTMD(Quick Text Markdown,快记一下):一种轻量级的标记语言

本项目是QTMD的vscode插件。使用方法:打开一个文档,搜索命令“qtmd”(ctrl+shift+p,搜索qtmd),目前有一个命令“QTMD:预览”。

QTMD是一种轻量级的标记语言,全写可以是“Quick Text Markdown”(还可以是……😀),中文名可以顺势叫做“快记一下”😉。

侧重“【写字】时来点格式”,而不是“在条条框框里【填空】”。主打一个简单明了。

当前版本:2.0.0。

功能/用法

普通文本

普通文本第一性。随便写,所见即所得。

  • 能保住空白字符的样子。
  • 甚至可以直接贴代码,不用为里面的特殊符号被吞掉、格式被打乱、字符被意外理解为特殊标记而发愁。

横线

  • 一行只有空白和减号,且减号>2个,则显示为横线。

格式化

(下文所提均指半角字符且不分大小写)

开启、退出格式化都需要先“激活”。激活符为斜杠【\】。

  • 激活符+标记+左圆括号【(】 开启格式化,激活符+半角右圆括号【)】结束。
    • 例:\b(要加粗的文本(多行)\)。
    • 内容可以多行(跨行)。
  • 简化:激活符+标记符+半角冒号【:】,仅格式化本行后续部分(单行模式)。
    • 例:\b:要加粗的文本(单行)。
    • 激活符+竖线【|】可提前结束。

格式标记:

  • !或b:加粗。例:\b(内容(多行))
  • /或i:斜体。例:\i:内容(单行)
  • _或u:下划线。
  • -或s:删除线。
  • ^或sup:上标。例:\sup:内容(单行)
  • v或sub:下标。
  • >或code:代码块。
  • '或"或q:引用。
  • h1到h6:标题。例:\h3:三级标题
  • 【#颜色名】或【#rgb颜色值】:文本颜色。例:\#red:红色 \#0000ff80:蓝色半透明(注意透明度2位也是十六进制的)
  • 【bg#颜色名】 【bg#rgb颜色值】:背景颜色,参考文本颜色。例:\bg#0000ff:蓝色默认透明度(不透明)

特殊格式

  • 链接使用link:
    • 多行:\link(链接文本(多行)\)链接url
    • 单行:\link:链接url
      • 链接url同时也是所显示的文本。
    • 链接url最后必须有空白字符(含换行)分隔。可以是相对地址、email。
  • 图片使用img,其他同link。
  • 无序列表:激活符+【.】开启无序列表的一项。
    • 例:\.:一项
    • 无需特别开启“列表”。
      • 写在同一行的两个列表视为两个列表。
      • 写在下一行的列表项视为同一个列表的其他项,若缩进更多则为子项(即直接缩进即可构造子列表),相同则为同级。
      • 两项之间若有空行,视为不同列表。
  • \# 有序列表的一项。其他同无序列表。
  • 表格:激活符+【[】开创一个表格行,中间可用激活符+【|】分格子,用激活符+【]】结束一个表格行。
    • 例:\[行1列1\\|行1列2\]。
    • 无需特别开启“表格”(同列表的逻辑)。
      • 写在同一行的两个表格行视为一左一右两个表格。
      • 若表格行下一行也是表格行,则视为属于同一个表格。
      • 表格行间若有空行,视为不同表格。

其他

  • 标记可以嵌套。
  • 连续的激活符视为普通文本,不再有激活功能。显示时会去掉一个激活符(不是折半!)。
  • 不能识别的格式均视为普通文本。
    • 因此激活符+非格式标记也按普通文本显示,所见即所得。但后续也许会成为某种格式。

参考

空文件

简介

vscode的QTMD预览插件 展开 收起
取消

发行版 (4)

全部
7个月前

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
TypeScript
1
https://gitee.com/quick-text-markdown/qtmd-viewer-vscode.git
git@gitee.com:quick-text-markdown/qtmd-viewer-vscode.git
quick-text-markdown
qtmd-viewer-vscode
qtmd-viewer-vscode
master

搜索帮助