Sanemark for Visual Studio Code

Sanemark is a fast, zero-config Markdown language server and toolchain written in Rust.

This extension brings the full power of Sanemark to VS Code: reference-link management, table and list formatting, link completions, broken-link diagnostics, and daily journal notes.

Features

• Consolidated Reference Links: Automatically collect all inline links into a clean ## References section at the bottom of the document upon formatting.
• Convert & Inline Commands:
  • Sanemark: Move References to Bottom: Consolidate all links into reference definitions.
  • Sanemark: Inline References: Inline all reference definitions back into text.
  • Sanemark: Convert to Inline Link: Convert selected reference links into inline links.
  • Sanemark: Copy as Inlined Markdown: Copy the current document or selection with all references converted to inline links to your system clipboard without modifying your file.
• GFM Table Normalization: Formats and neatly aligns GitHub Flavored Markdown tables with proper delimiter rows.
• List Normalization: Normalizes list markers to - and renumbers ordered lists incrementally.
• Broken Link Diagnostics: Catches broken relative file links and images directly in the editor.
• Fast Path Completion: Offers auto-completions for relative paths, images, and Markdown notes with fuzzy matching.
• Quick-Insert Snippets: Type / or @ at the start of a line or after a space to insert dates (today, tomorrow, yesterday), timestamps, or linked workspace files.
• Journal & Daily Notes: Quickly open or create daily notes from configurable templates (Sanemark: Open Today's Journal Note).

Getting Started

Automatic Binary Setup

By default, the extension will check if sanemark is available on your $PATH. If not found, it prompts you to automatically download the latest pre-compiled binary release for your platform directly from GitHub Releases.

For extension-downloaded servers, the extension checks GitHub for a newer stable release after activation and periodically while VS Code stays open, at most once every 24 hours. Choose Update and Restart to install it and restart the server, or Later to defer until a future check. Background check failures are recorded in the Sanemark Output channel and do not prevent the installed server from running. Disable automatic checks with "sanemark.checkForUpdates": false.

Run Sanemark: Check for Language Server Updates to check immediately, even when automatic checks are disabled. Download or Update Language Server also checks for updates, or downloads a server if none is installed. Servers configured through sanemark.serverPath or found on PATH must be updated using their installation method. VS Code's extension auto-update setting updates the extension separately. New downloads use separate directories; previous binaries are retained so other open VS Code windows can continue using them until restarted.

Manual Setup

If you prefer to compile or manage the binary yourself:

# Using cargo
cargo install sanemark

# Or using Nix
nix profile install github:nkitsaini/sanemark

You can also explicitly configure the path to the executable in your VS Code settings:

{
  "sanemark.serverPath": "/path/to/sanemark"
}

To see which executable the extension selected, open View: Toggle Output from the Command Palette and choose Sanemark in the Output panel's channel picker.

Extension Commands

All commands can be found in the Command Palette (Ctrl+Shift+P / Cmd+Shift+P):

Configuration

Customise behaviour in your VS Code settings (settings.json):

{
  // Path to custom sanemark executable (null = PATH or auto-downloaded)
  "sanemark.serverPath": null,

  // GitHub Flavored Markdown support
  "sanemark.gfm": true,

  // Formatting options
  "sanemark.formatting.moveReferencesToBottom": true,
  "sanemark.formatting.referencesHeading": "References",
  "sanemark.formatting.formatTables": true,
  "sanemark.formatting.formatLists": true,

  // Diagnostics
  "sanemark.diagnostics.brokenLinks": true,
  "sanemark.diagnostics.severity": "warning",
  "sanemark.diagnostics.checkImages": true,
  "sanemark.diagnostics.ignore": [],

  // Completions
  "sanemark.completion.paths": true,
  "sanemark.completion.pathStyle": "auto",
  "sanemark.completion.showHiddenFiles": false,
  "sanemark.completion.gitignore": true,
  "sanemark.completion.deepPaths": true,

  // Snippets
  "sanemark.snippets.enabled": true,
  "sanemark.snippets.fileLinks": true,
  "sanemark.snippets.dateFormat": "%Y-%m-%d",
  "sanemark.snippets.timeFormat": "%H:%M",

  // Journal / Daily Notes
  "sanemark.journal.directory": "journal",
  "sanemark.journal.template": null
}

License

MIT © Ankit Saini