Skip to content

Commit 87df4ab

Browse files
committed
fix: update readme and description
Signed-off-by: Gordon Smith <GordonJSmith@gmail.com>
1 parent f4480de commit 87df4ab

2 files changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ This extension now supports the new **ObservableHQ Notebook 2.0** format! 🎉
1717

1818
### Quick Start with ObservableHQ Notebook
1919

20-
1. Use Command Palette: "Observable Kit: Create New Notebook"
21-
2. Choose a name (e.g., `my-notebook`) - will create `my-notebook.onb.html`
22-
3. Start writing vanilla JavaScript with `display()` function
23-
4. Use "Observable Kit: Preview" to see live preview
24-
5. Use "Observable Kit: Build Static Site" for deployment
20+
1. Run the Command Palette entry **"Observable Kit: Observable Kit Notebook"** to scaffold a new notebook
21+
2. Choose a name (e.g., `my-notebook`) – the command creates `my-notebook.onb.html`
22+
3. Click **Switch to Notebook View** (toolbar button or command) to open the interactive editor and start writing vanilla JavaScript with `display()`
23+
4. Use **Switch to Text View** any time you want to edit the underlying HTML shell or metadata
24+
5. Run **Observable Kit: Build Static Site** when you are ready to produce deployable output
2525

2626
### HTML File Detection & View Switching
2727

@@ -75,13 +75,13 @@ Once a file is open, you can switch between views using toolbar buttons:
7575

7676
## Recommended Extension Pack
7777

78-
To get the full experience, it is recommended to install this extension as part of the [JavsaScript Notebook](https://marketplace.visualstudio.com/items?itemName=GordonSmith.js-notebook-extension-pack) extension pack.
78+
To get the full experience, install this extension as part of the [JavaScript Notebook](https://marketplace.visualstudio.com/items?itemName=GordonSmith.js-notebook-extension-pack) extension pack.
7979

8080
## Quick Start with ObservableHQ Notebook-Kit
8181

8282
![Demo GIF](./images/notebook-kit-demo.gif)
8383

84-
1. Open a `notebook-kit`notebook (extension .html)
84+
1. Open a `notebook-kit` notebook (extension .html)
8585
2. Click "Switch to Notebook View" in the text toolbar.
8686
3. Edit, run and save your notebook.
8787
4. Optionally click "Switch to Text View" to go back to the HTML source.
@@ -110,7 +110,7 @@ To get the full experience, it is recommended to install this extension as part
110110

111111
## Commands
112112

113-
_All commands are prefixed with "OJS" and are available via the command palette or by default shortcut key mappings_
113+
_Legacy commands are prefixed with "OJS"; Notebook Kit commands appear under "Observable Kit" in the Command Palette_
114114

115115
### Legacy OJS Commands
116116

@@ -137,7 +137,7 @@ _All commands are prefixed with "OJS" and are available via the command palette
137137

138138
## Settings
139139

140-
_All settings are prefixed with "ojs." and are available via `file -> preferneces -> settings` menu_
140+
_All settings are prefixed with "ojs." and are available via `File -> Preferences -> Settings`_
141141

142142
| Setting | Default | Description |
143143
| ------------------------ | :-----: | ------------------------------------------------------- |

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"version": "0.4.56",
55
"publisher": "GordonSmith",
66
"displayName": "Observable JS",
7-
"description": "Interpreter for ObservableHQ Notebooks - Includes VS Code Notebooks with Observable, Observable \"Markdown\" files with embedded Observable (.omd) and Observable \"JavaScript\" files.",
7+
"description": "ObservableHQ Notebook + Notebook Kit 2.0 tools for VS Code: author .onb.html notebooks, switch between HTML/notebook views, edit legacy .ojsnb/.ojs/.omd files, preview, import/export, and build static sites.",
88
"icon": "images/ObservableJS.png",
99
"readme": "README.md",
1010
"categories": [

0 commit comments

Comments
 (0)