Install
Install Inkline from Obsidian's community plugins, or by hand with the install ZIP from GitHub releases; no separate installer plugin is needed. If you would rather have updates arrive by themselves, BRAT is an optional alternative.
What you need
- Obsidian 1.13.4 or later on desktop, with a mouse or a trackpad. Inkline is tested on Linux; Windows and macOS should work but are not tested. Obsidian's mobile apps do not offer it.
- A vault. To try Inkline, or a pre-release of it, without touching your own notes, use a new vault or a copy of one.
Each change is tested in Obsidian 1.13.4, on the oldest installer that can run it, and in the latest public release of Obsidian. The host tests run on Linux; see Promises and evidence for the tested platforms and limits.
Install from Obsidian's community plugins
- In Obsidian, open Settings → Community plugins, and turn community plugins on if needed.
- Select Browse, search for Inkline, and select it.
- Select Install, then Enable.
Inkline's page in the directory is https://community.obsidian.md/plugins/inkline.
Inkline is ready: run Inkline: Insert symbol from the command palette in a note, as Your first symbol shows.
If Inkline does not show there yet, install the ZIP from the latest release, below.
Install the ZIP
Open the releases page and download inkline-<version>.zip from the Assets of the release marked Latest, the newest public release, such as
1.0.0. A public release has an even minor version. A pre-release, marked Pre-release, has an odd one, such as1.1.0, and is for trying changes before the next public release; take one only if you want to. Releases before 0.9.0 have a suffix instead, such as0.3.0-alpha.8, and are pre-releases too. 1.0.0 is the first stable release, and the file format is frozen: a symbol saved by 0.9.2 or later opens as it is, and one saved by an earlier version opens as a picture, as Update says. GitHub's Source code archives contain source files, not the built plugin.Extract the ZIP into your vault's
.obsidian/plugins/directory. The ZIP contains its owninkline/folder, so the result must be:text.obsidian/plugins/inkline/main.js .obsidian/plugins/inkline/manifest.json .obsidian/plugins/inkline/styles.cssThe
.obsidiandirectory is hidden on some systems. If your vault uses a different configuration directory, use itsplugins/directory instead.In Obsidian, open Settings → Community plugins, turn community plugins on if needed, and enable Inkline. Restart Obsidian if it is not listed.
Inkline is ready: run Inkline: Insert symbol from the command palette in a note, as Your first symbol shows.
The ZIP has the same three plugin files as the loose assets. SHA256SUMS records SHA-256 checksums for both. The older 0.1.0 release predates the install ZIP; use the loose-file steps below for that version.
From 0.9.4, a release also carries a copy of the file format as that release has it, named by the format's version and the document's revision, such as inkline-file-format-version-1-revision-1.md. Installing does not need it: it is there so that what symbol files hold stays described wherever the release is kept.
Install the loose files
Download main.js, manifest.json, and styles.css from the same GitHub release. Create .obsidian/plugins/inkline/ in your vault and put all three files inside it, then enable Inkline under Settings → Community plugins. A vault with a different configuration directory has its plugins there instead.
Build and install a development build
You need Git and Node.js 24.22.1 or a later 24 release, or 26.12.1 or later, with the npm it ships. A development build can include unreleased changes.
git clone https://github.com/viell-dev/slop-inkline.git
cd slop-inkline
npm ci
npm run buildThe build writes main.js, manifest.json, and styles.css to dist/. Install those three files with the loose-file steps above. To make a local install ZIP as well, run node scripts/package.ts dist test-results/package.
Update
Once Inkline shows in Obsidian's community plugins, Obsidian offers each new public release as an update under Settings → Community plugins, however you installed it, as The community directory says. Until then, update a ZIP installation by hand, as below. Move to a pre-release by hand too:
- Save any open drawing, then turn Inkline off under Settings → Community plugins.
- Download the newer release's install ZIP and extract it into the same
.obsidian/plugins/directory. Replace the three plugin files ininkline/; keepdata.json, which stores your preferences. If your tool extracts elsewhere, copy only the three plugin files into the existinginkline/directory rather than replacing the directory. For a loose-file installation, replace only those same three files. - Turn Inkline on again, or restart Obsidian.
Your drawings remain ordinary PNG attachments in the vault.
Updating from a version before 0.9.2: the file format became final in 0.9.2, and Inkline no longer reads the strokes of earlier files. Your symbols and the notes that use them don't change, and they look as they did, but each symbol opens in the editor as a picture to draw over, and the editor says why. Saving one stores strokes from then on. Unsaved drawings kept as drafts by an earlier version are dropped, so finish what you are drawing before you update.
A symbol saved in a newer version of the file format than the one your Inkline reads opens with a notice to update Inkline rather than in the editor, so that it is never saved over by a version that does not understand it. A symbol that a later Inkline saved in a format your version reads opens as usual.
Install with BRAT
BRAT is a third-party plugin that installs other plugins from their GitHub releases and keeps them updated. It is an optional alternative to the steps above, never a requirement, and it installs the same main.js, manifest.json, and styles.css. Inkline's tests show that it works, not that it is safe to use, and BRAT does not check SHA256SUMS.
- Under Settings → Community plugins, turn community plugins on if needed, select Browse, then install and enable BRAT.
- Run BRAT: Plugins: Add a beta plugin for testing (with or without version) from the command palette.
- Enter
viell-dev/slop-inklineunder Repository and press Tab. BRAT lists the versions once you leave the field. - Select Select a version... and choose latest, to follow every new release, or a version number, to stay on that release.
- Leave Enable after installing the plugin on and GitHub token empty, and select Add plugin.
latest always takes the highest version number, whether or not GitHub marks that release as a pre-release: BRAT has no setting to leave pre-releases out. So once a pre-release such as 1.1.0 is published, latest moves to it, and to every pre-release after it. To stay on public releases, choose a public version, such as 1.0.0, and change it yourself when the next one comes out.
With latest, BRAT looks for a new version about a minute after Obsidian starts, unless you turn off Auto-update plugins at startup in its settings, and when you run BRAT: Plugins: Check for updates to all beta plugins and UPDATE. It replaces the three plugin files and reloads Inkline, so you need not turn it off first. data.json and your drawings stay as they are. An open editor closes when Inkline reloads, and keeps its unsaved strokes as a draft, which it offers back when you next open that symbol, or a new symbol in the same note. Pre-releases are for testing, so choose a version number if you want to decide when you update.
BRAT never updates a version you chose. To change it, or to move between a version and latest, repeat steps 2 to 5 with your new choice, and BRAT installs it at once.
The community directory
Obsidian's community plugins, under Settings → Community plugins → Browse, offer Inkline's public releases, from 1.0.0 on, as Install from Obsidian's community plugins shows. If Inkline does not show there yet, install the ZIP. Once it shows there, Obsidian offers each new public release to every installation of Inkline, from its community plugins or from a ZIP.
The directory offers public releases only, those with an even minor version. Pre-releases stay on the releases page, where every release keeps its ZIP and loose files, and BRAT remains an optional way to follow them.
Obsidian offers the newest public release only when it is higher than the version installed: someone on a 0.9 pre-release, or on an earlier public release, is offered it. Someone on a later pre-release, such as 1.1.0, stays on it until a public release is higher, such as 1.2.0.
Turn off or remove
Turn Inkline off under Settings → Community plugins, or uninstall it there, which deletes its plugin directory. Your symbols stay in the vault with ordinary embeds, which Obsidian shows as images, as Without Inkline describes. Turning Inkline off with an editor open keeps its unsaved strokes as a draft, which the editor offers back when Inkline is on again.
Turning Inkline off also closes Inkline: Insert existing symbol, and stops a rename or a change of readings and translations that the library is still saving and that has not yet reached Obsidian, with a notice saying so, so that you can make it again once Inkline is on. A rename that Obsidian has not begun, from the library or the editor, stops at once even if it is waiting for Obsidian to index the vault or finish another rename. One that Obsidian has begun finishes, and the embed of a new symbol renamed as it was saved follows it to the new name.
If you installed Inkline with BRAT, also remove viell-dev/slop-inkline from the Beta plugin list in BRAT's settings, with its × button, twice: BRAT otherwise installs it again at its next check. Removing it there leaves the plugin installed. A plugin added since Obsidian started can be missing from the list until you restart Obsidian.