Knotis
Write and preview Knotis sites in VS Code with a live Markdown preview and tools for outline-style authoring.
Features
Live preview
- Preview updates as you type.
- Editor and preview scroll together in both directions.
- Inside a Knotis site, the preview uses the site's Zensical configuration and renders wikilinks, content tags, admonitions, Mermaid diagrams, tables, code blocks, highlights, images, GIFs, and videos.
Outline editing
- Enter continues or splits bullet and numbered items.
- Enter or Backspace on an empty marker exits or outdents the list.
- Tab and Shift+Tab indent or outdent items and multi-line selections.
- Tables, fenced code, Mermaid blocks, and image lines move as complete structured blocks.
- Pasted tables and fenced blocks are realigned to the surrounding list indentation.
The editor title bar also provides commands for bold, italic, highlights, [[wikilinks]], front matter, and bullet or numbered lists.
Smart paste
Cmd+V on macOS and Ctrl+V on Windows and Linux adds a few Markdown-aware behaviors:
- A selected phrase plus a copied URL becomes a Markdown link.
- A clipboard image is saved into the site and inserted as Markdown.
- Copied
.png, .jpg, .jpeg, .gif, and .mp4 files are copied or linked without changing their format.
- Media already under the site's assets folder is linked in place.
- All other clipboard content uses normal paste.
Getting Started
- Install the extension and open the folder containing your site's
zensical.toml.
- Open a Markdown file under
docs/.
- Run Knotis: Open, click the preview button in the editor title bar, or press Cmd+Shift+K on macOS / Ctrl+Shift+K elsewhere.
For the complete site experience, including panes, search, graphs, and slides, run knotis serve and open the site in your browser.
Controls
| Control |
Action |
| Knotis: Open |
Open the preview for the active Markdown file |
| Knotis: Open Home |
Open the site home page |
| Knotis: Refresh |
Rebuild the current preview |
| Knotis: Check Setup |
Show setup diagnostics in the Knotis output channel |
| Knotis: Toggle Auto Open |
Turn automatic preview opening on or off |
| Knotis: Bullet List |
Convert the current line or selection to bullets |
| Knotis: Numbered List |
Convert the current line or selection to numbered items |
| Knotis: Wikilink |
Add or remove [[wikilink]] markup |
| Knotis: Paste Image |
Save clipboard media and insert its Markdown link |
| Cmd/Ctrl+B |
Toggle bold |
| Cmd/Ctrl+I |
Toggle italic |
Settings
| Setting |
Default |
Purpose |
knotisPreview.autoOpen |
true |
Open previews automatically for detected Knotis site files |
knotisPreview.pythonPath |
Auto-detect |
Select a Python executable when automatic Zensical detection fails |
knotisPreview.editorSettings.tabSize |
4 |
Set the tab width for Markdown-like editors; use 0 to disable |
Documentation
Learn how to install Knotis, create a site, write content, use panes and graphs, build slides, and publish your site at knotis documentation site.
| |