Alias:
Date: 2022-03-29
Time: 16:55


文本编辑状态: #DOING

因为在网上都没找到完整的新手向教程,所以参考MarkDown超级教程 Obsidian版的版式写了Roam基本语法的小结,外加一些自己在Roam上总结的经验。本着实用至上的想法,处理的略显粗糙;欢迎大家给出建议交流经验,文本我后续也会继续完善的。

Tags: #新手村

前期资料收集

  1. RoamJS Extensions
  2. 100 ROAM TIPS: Beginner to Advanced in 25 Mins | Roam Research Course - YouTube
  3. MarkDown超级教程 Obsidian版 - Obsidian Publish

软件

软件特点: 互链、block引用、完全在线编辑
相似软件: [[Obsidian]] [[Logseq]]
相关软件: [[Telegroam]]

排雷List

  • 文字/图片/文件是否需要科学上网才能访问 -> 文字可以,图片/文件不行
  • 基本操作语法有哪些 -> 基本语法不多,但未找到完全List
  • 如何简洁地显示表格 -> 现有方案极其繁琐
  • 是否方便外链分享 -> 只能分享给注册用户
  • JS插件 -> 有一定体量,可以满足基本的需求
  • CSS插件 -> 目前了解情况是可以做到一些调色和小的框架上的调整
  • 文件和图片导入方式 -> 会存在RR自己的基于Google的云存储里面,访问需要科学上网

试用方式

在线graph
注册之后有一个月试用期,无意继续付费可以在到期前取消续费,此操作不影响试用时限。

本地graph

  1. 浏览器端实现方法
    注册成功后,在浏览器中键入https://roamresearch.com/#/offline/本地graph名称,创建新的本地graph。
  2. 客户端实现方法
    参考吕立青的视频教程,在客户端调出终端并键入location.href = "https://roamresearch.com/#/offline/本地graph名称",创立新的本地graph。

基本语法

1. 标题&目录

1.1 标题

Roam Research有三级标题,基本语法与Markdown通用语法类似

# 这是一级标题
## 这是二级标题
### 这是三级标题

1.2 目录

目前来看,Roam Research可能无TOC目录

2. 斜体&粗体

2.1 斜体

斜体的格式:

  1. __ + 文本内容 + __
  2. 选中文字,按住ctrl + i快捷键

说明:
不同于Markdown,这里是双下划线

2.2 粗体

粗体的格式:

  1. ** + 文本内容 + **
  2. 选中文字,按住ctrl + b快捷键

示范:
 

3. 线

3.1 水平分割线

水平分割线的格式:
水平分割线由3个_组成

3.2 文本删除线

文本删除线的格式:

  1. ~ + 文本内容 + ~
  2. 选中文字,按住win + y快捷键

示范:
 

3.3 文本下划线

4. 列表&引用

4.1 有序列表

4.2 无序列表

4.3 引用

斜体的格式:

  1. > + 空格 + 文本内容

说明:
不同于Markdown,效果仅作用于一个block,并在敲击Enter后进入下一个block

示范:
 

4.4 缩进&退格

缩进的格式:

  1. Tab

退格的格式:

  1. Shift + Tab

示范:
 

5. 网页链接与图像

5.1 网页链接

网页链接的格式:

  1. [ + 显示文本内容 +] + ( + 链接地址 + )

说明:
显示文本内容,是在渲染界面实际 可见 的文本,用以 说明 链接

5.2 图像

网页链接的格式:

  1. 图像格式,就是在网页链接前面加个 ! (英文格式的),! 代表 可见

说明:
[ ] 方括号里的文字信息没啥实质的作用,只是方便在源代码模式下,知道这个图片是什么,在渲染界面是不会显示的。

示范:
 

6.表格

Roam Research表格相较于Markdown要复杂得多

-   {{table}}
    -   表头1
        -   表头2
            -   表头3
    -   数据1
        -   数据2
            -   数据3
    -   信息1
        -   信息2
            -   信息3

示范:
 

7.代码域

7.1 行内代码

行内代码 的格式:

  • 输入两个 ` 反引号 ,在中间写代码内容
    补充:
  • 行内代码不一定非得写代码,也可以作为着重标记,突出显示内容
  • 行内代码中,源代码界面和渲染界面是完全一致的,标识符会失效
  • 所谓行内代码: 只要你的屏幕足够宽,它就不会换行

7.2 代码块

代码块 的格式:

  1. 在首行和末行各加 三个 ` 反引号
    • ``` + 语言种类
      代码内容
      ```

补充:

  • 在代码块也不一定要写代码,可以写一段突出的文本内容,语言类型可以填写 txt 或者 干脆不写
  • 代码块中,源代码界面和渲染界面是完全一致的,标识符会失效

8. 任务列表

任务列表的格式:
{{TODO}} + 任务内容
补充:
TODO必须大写,按下Enter之后下一行不会自动补全

9. 注释

注释的格式:

10. 变量

无网页链接变量、无脚注

11. 拓展文本格式标记

似乎不支持html语法

12. 拓展文本显示效果

12.1 文本高亮

斜体的格式:

  1. ^^ + 文本内容 + ^^

说明:
不同于Markdown,这里是双^

12.2 上标&下标

12.3 Emoji符号

暂未发现

13. 转义字符

未识别

14. 空格&换行&强制删除

15. 嵌入

15.1 嵌入视频

格式:
{{video: https://youtube.com/lOoMoRVImeo}}

15.2 嵌入网页

格式:
{{iframe: https://worrydream.com}}

15.3 嵌入PDF

格式:
{{pdf: https://a.link.to/a.pdf}}

16. Latex公式

16.1 行内公式

16.2 公式块

格式:

  • $$
    公式块
    $$

示例:

% 化学公式
$$
\ce{Zn^2+  <=>[+ 2OH-][+ 2H+]  $\underset{\text{amphoteres Hydroxid}}{\ce{Zn(OH)2 v}}$  <=>[+ 2OH-][+ 2H+]  $\underset{\text{Hydroxozikat}}{\ce{[Zn(OH)4]^2-}}$}
$$

 

% 麦克斯韦方程组
$$
\begin{array}{lll}
\nabla\times E &=& -\;\frac{\partial{B}}{\partial{t}}   
\ \nabla\times H &=& \frac{\partial{D}}{\partial{t}}+J   
\ \nabla\cdot D &=& \rho
\ \nabla\cdot B &=& 0
\ \end{array}
$$

 

% 薛定谔方程
$$
i\hbar\frac{\partial \psi}{\partial t} = \frac{-\hbar^2}{2m} \left(\frac{\partial^2}{\partial x^2} + \frac{\partial^2}{\partial y^2}+\frac{\partial^2}{\partial z^2} \right) \psi + V \psi
$$

效果:

Roam Research输出图
Obsidian输出图

补充:

插件相关

插件来源:
RoamJS Extensions

插件安装

Roam Research插件安装有两种方式,以下以Marketplace为例进行说明:

自动安装

点击页面中的 Copy Extension 按钮复制插件内容,并将其粘贴在任一[[Roam Research]]页面来进行安装,并点击弹出的 "Yes, I Know What I'm Doing".

COPY EXTENSION

手动安装

如果上面的 Copy Extension 按钮无法正常工作,可以使用下面的手动安装方法。

首先通过文本 {{[[roam/js]]}} 在[[Roam Research]]的任一页面创建block,然后用 ``` 创建代码块并将页面中的代码粘贴入代码块内:

var existing = document.getElementById("roamjs-marketplace-main");
if (!existing) {
  var extension = document.createElement("script");
  extension.src = "https://roamjs.com/marketplace/main.js";
  extension.id = "roamjs-marketplace-main";
  extension.async = true;
  extension.type = "text/javascript";
  document.getElementsByTagName("head")[0].appendChild(extension);
}

最后点击, "Yes, I Know What I'm Doing".

Marketplace插件使用方法

通过CTRL/CMD + p 调用Roam的命令行,搜索Open Marketplace 并点击Enter 确认。
 

|500
Marketplace界面


进入Marketplace之后便可以管理和安装Roam的JS插件了,每个插件的使用方法对应的页面都有视频介绍。

目前我安装的插件:

  • Attr Tables
  • Calculate
  • Chart
  • Maps
  • Roam42
  • Todont
  • Wiki Data

CSS相关

Roam的CSS比Obsidian可玩性要弱挺多的,没太去折腾。有兴趣的可以自行搜索,操作和JS插件安装类似。

Roam Research试用总结

我本身是一个Obsidian用户,Roam试用时间也没几天。原计划是把RR作为OB的线上双链的补充,但体验下来却感觉自己的需求似乎并不能很好的满足。似乎Roam本身的语法和结构都比较简单,适合纯文本操作,且没有一个美观的Layout;相比而言Obsidian无论在语法丰富度和CSS界面风格上都更为优秀。Roam目前看来最引以为傲就是Block级别的双链操作,但与此同时也限制了Block本身Layout的丰富度,连一个简单的{{table}}都要通过title的多级嵌套来实现。

本文写出来主要是方便其它新人入坑一起排雷,以上!

3
2