Skip to content

FAQ

Answers to common questions and fixes for issues people hit most often. If your question isn't here, check the rest of the docs or the project's GitHub issues.

How do I specify a custom MathJax script?

VNote uses MathJax 3 to render math. To choose which MathJax build it loads:

  1. Copy web/js/mathjax.js from the default configuration folder into the same path (web/js/mathjax.js) under your user configuration folder. VNote will use your copy instead of the default.

  2. Edit the copied file and set the script URL. The default is:

    this.mathJaxScript = 'https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-svg.js';

To use a local copy for offline use, download MathJax and point to it:

this.mathJaxScript = 'file://c:/Users/foo/mathjax/tex-svg.js';

See Math & Diagrams and Settings for context.

VNote crashes after a version update

This often happens when the update spans several versions and an old configuration is no longer compatible. Open your user configuration folder and delete vnotex.json, then restart VNote. See Settings for where that folder is.

The interface freezes, the cursor is invisible in edit mode, or VNote crashes when opening a note

On Windows, these three symptoms are usually caused by the display-card driver. Work through these steps, restarting VNote after each to check whether it helped:

  1. Update your display-card driver.
  2. Schedule VNote to run with the integrated display card.
  3. If that doesn't help, try each OpenGL value one by one in the Settings dialog.
  4. Make sure VNote's executable folder is on the C: drive.

Where are my notes stored?

Wherever you put them. Each notebook is an ordinary directory (its Notebook Root Folder) containing plain Markdown files, with images kept in an assets folder (vx_assets by default). Your notes are never locked inside a database — VNote's own index and caches are kept separately from your content. See Notebooks, Folders & Notes.

How do I sync my notes across devices?

VNote has a built-in Git sync for bundled notebooks, and — since a notebook is just a folder — you can also sync it with any tool you trust, such as Dropbox, OneDrive, or Nextcloud. See Notebook Sync.

Can I use VNote portably (from a USB drive)?

Yes. Bundle the configuration next to the executable as described in Make VNote portable.

How do I import my existing Markdown files?

Create a bundled notebook and import your folder into it — see Importing & Migrating. If you would rather adopt the existing folder exactly as it is, open it with New Notebook → Type: Raw notebook, which browses it in place but has no tags, attachments, or recycle bin. For migrating from other apps, see Data Migration.

What is the difference between a bundled and a raw notebook?

A bundled notebook keeps an index under its root folder, and that index is what enables tags, attachments, the recycle bin, and built-in Git sync. A raw notebook has no index — it browses a folder in place, like a file browser — so those features are unavailable. Prefer bundled, and choose raw only when the existing folder must be adopted as it is, or is managed outside VNote. See Notebooks, Folders & Notes.