Skip to content

Obsidian Compatibility ​

A Jylos vault is a plain folder of Markdown files, the same as an Obsidian vault: you can open one folder with both apps. Jylos writes nothing of its own in your notes. A note keeps only what you wrote in it.

What both apps share ​

  • The notes and their text, including headings, lists, tasks, callouts, code and Mermaid diagrams.
  • Properties (the YAML at the top of a note). When you don't change them, Jylos saves them exactly as they were, with your comments, quotes and order. It reads them as Obsidian does (YAML 1.2): no, yes, 10:30 or 1_000 are text, not a boolean or a number; a list stays a list and an empty property stays empty.
  • Templates, with Obsidian's variables ({{date:YYYY-MM-DD}}…) and, if you turn it on, Templater's syntax (<% tp.date.now() %>). The daily note follows Obsidian's rules. See Templates and Daily Note.
  • Links: [[Note]], [[Folder/Note]], [[Note#Heading]], [[Note|text]], embeds ![[…]], aliases, and links inside properties (up: "[[Index]]").
  • Tags, written in the text (#idea) or in the tags property.
  • Canvas files (.canvas) and attachments.
  • The trash, the .trash folder.

What each app keeps to itself ​

Each app keeps its own state in a hidden folder of the vault, which the other ignores:

ObsidianJylos
Folder.obsidian/.jylos/
FavoritesBookmarksFavorites
Pinned notes— (it pins tabs)Pinned
Workspaces.obsidian/Jylos' app data (outside the vault)

So favorites and pinned notes are not shared with Obsidian: a bookmark in Obsidian is not a favorite in Jylos, nor the other way round. Jylos never writes in .obsidian/.

To bring Obsidian's bookmarks over once, use Tools → Import Obsidian Bookmarks: the notes bookmarked in Obsidian (also inside groups) become favorites in Jylos. It only reads Obsidian's bookmarks; bookmarks of searches, folders, headings or blocks have no equivalent and are skipped, and the result says how many.

Bookmarks are not tags: a tag (#idea, tags:) is written in the note and classifies it; a bookmark is a shortcut kept in the app's settings, outside the note.

Obsidian's settings ​

Jylos' settings for a vault (templates, daily note, new notes, Templater) are its own, in Preferences → Vault. Tools → Import Obsidian Settings… takes them from .obsidian at once:

  • What it takes: the templates folder and its formats (Templates plugin), the daily note's folder, format and template (Daily notes plugin), where new notes go, and from Templater its templates folder, whether it writes a note when it is created and its folder templates.
  • Only for the plugins you have on in Obsidian, since a plugin turned off leaves its old settings in .obsidian. Where Obsidian has no setting, its default is taken. Templater counts as on when it is listed in .obsidian/community-plugins.json.
  • Before changing anything it shows what would change and asks.
  • The first time a vault with .obsidian is opened, Jylos offers it once, even if you say "Not now"; the command stays in Tools.

Then each app keeps its own settings: if you change them in Obsidian, import them again. Obsidian's files are only read.

Good to know ​

  • Renaming a note outside Jylos (in Obsidian, Finder or with Git) loses its favorite and pinned marks, because Jylos finds them by the note's path. Obsidian bookmarks have the same limit.
  • .jylos/ is part of the vault and is synced with it (Git, iCloud…). Favorites and pinned marks are kept in one file, .jylos/document-metadata.json. If you mark notes on two devices at the same time and sync with Git, that file can conflict.
  • Private notes keep private: true in their properties: their text is encrypted, and Jylos needs the flag to open them.

Notes saved by older versions of Jylos ​

Older versions of Jylos wrote id, title, modified, favorite, pinned and deleted in every note they saved, and Obsidian showed them as properties. Jylos now takes them out:

  • When a note is saved, it loses those fields. Its favorite and pinned marks, its created date and its other properties are kept.
  • Tools → Clean Up Jylos Metadata… cleans the whole vault at once. It says first how many notes it will change and asks; it copies each one to .jylos/backups/ before changing it.

Only notes whose properties Jylos wrote are touched. If you wrote one of those fields yourself (an id, a modified date…), it is yours and stays.

Free and open source. Local-first, offline, and Markdown-based.
Contact: ed.dzsn@protonmail.com