Skip to content

Commit ec8a2a9

Browse files
authored
Adding demos (#434)
* add some demos * 1.2.5
1 parent eeca663 commit ec8a2a9

File tree

11 files changed

+34
-18
lines changed

11 files changed

+34
-18
lines changed

docs/deep-nav.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ Hitting the corresponding shortcut given by the hint will either navigate you to
2525

2626
# Demo
2727

28-
[Video](https://www.youtube.com/watch?v=tb_6HdAhZwo)
28+
https://github.com/RoamJS/workbench/assets/3792666/23f9d582-7c08-4821-9775-97b1cedaca9c

docs/format-converter.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,7 @@ To open the format converter, use the keyboard shortcut `Alt + m`. This will ope
1515
The format converter also supports a web view. Hit the keyboard shortcut `Alt + Shift + M` to open a dialog that displays what your Roam page would look like on a webpage.
1616

1717
It's possible to assign a unique hotkey to individual commands, should you prefer to do so. To accomplish this, navigate to either `Settings` > `Hotkeys` or the WorkBench Extension Settings.
18+
19+
# Demo
20+
21+
https://github.com/RoamJS/workbench/assets/3792666/ecb4922f-43f5-4d40-ac5a-ad0db3c883b6

docs/image-ocr.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,3 @@ On hover, a magnifying glass icon with a `T` will appear near the Roam native bl
1717
Once the extension finishes, it will replace the `Loading...` text with all the new text it parsed from the image. If the text begins with a bullet or dash on a line, the bullet will be stripped, leaving the rest of the text content.
1818

1919
This extension is currently only supported in online mode.
20-
21-
# Demo
22-
23-
![Image OCR Demo](media/image-ocr-demo.gif)

docs/import-article.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,30 @@ Toggle the Import Article module on inside WorkBench.
1010

1111
![](media/toggle-import-article.png)
1212

13-
In the Roam Command Palette, enter `Import Article into Roam`.
13+
In the Roam Command Palette, enter `Import Article into Roam`. You could also use the `ALT+SHIFT+I` or `OPT+SHIFT+I` keyboard shortcut to bring up the import the article dialog.
1414

15-
There will be a dialog with a text input where you paste in the article's URL. Then, you could hit the `IMPORT` button and the contents of the article will be imported into your Roam DB!
15+
Input the article's URL where it says `Enter url ...`. Then, hit the `Import Article` button and the contents of the article will be imported into your Roam DB!
16+
17+
## Indent Blocks Under Header
18+
19+
The overlay supports an `Indent Blocks Under Header` option.
20+
21+
When checked, this will paste contents as children blocks of each header in the article.
22+
23+
# Reporting Import Issues
1624

1725
The extension is making it's best guess on what content from the link is considered the article and what isn't. To help improve the extension over time, send article links that did not quite format correctly to [email protected].
1826

19-
If there is already an article link in a block, you could use the `ALT+SHIFT+I` or the `OPT+SHIFT+I` keyboard shortcut to automatically import the article from the link. It's possible to assign a unique hotkey to this command, should you prefer to do so. To accomplish this, navigate to either `Settings` > `Hotkeys` or the WorkBench Extension Settings.
27+
# Hotkey
2028

21-
The overlay supports an "Indent Under Header" option. When checked, this will paste contents as children of each header in the article.
29+
It's possible to assign a unique hotkey to the command, should you prefer to do so. To accomplish this, navigate to either `Settings` > `Hotkeys` or the WorkBench Extension Settings.
30+
31+
# SmartBlocks Integration
2232

2333
This extension is also integrated with [SmartBlocks](https://github.com/RoamJS/smartblocks)!
2434

2535
If you have both this extension and SmartBlocks installed, there will be a `<%ARTICLE:[link]%>` command available. Replace `[link]` with the desired url that you'd like to import. The command will automatically run the article import logic and paste the contents in the blocks before continuing with the rest of the workflow.
36+
37+
# Demo
38+
39+
https://github.com/RoamJS/workbench/assets/3792666/55c64d63-ddde-4ceb-9e03-1d2b50156344
5.5 MB
Binary file not shown.

docs/media/demo-deep-nav.mp4

5.06 MB
Binary file not shown.
8.59 MB
Binary file not shown.

docs/media/demo-import-article.mp4

8.04 MB
Binary file not shown.

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
"@types/mozilla-readability": "^0.2.0",
2424
"@types/turndown": "^5.0.1"
2525
},
26-
"version": "1.2.4",
26+
"version": "1.2.5",
2727
"samepage": {
2828
"extends": "node_modules/roamjs-components/package.json"
2929
}

0 commit comments

Comments
 (0)