Skip to content
Baram

Documentation

Welcome to the Baram documentation. Baram is a lightweight, beautiful WYSIWYG markdown editor with AI integration and bidirectional links — the pages below cover everything from your first document to publishing a plugin of your own.

Start here

Section titled “Start here”

New to Baram? These steps take you from an empty window to a linked set of notes.

  1. Install Baram — download the build for your platform, or build it from source.

  2. Open a folder — point Baram at a folder of markdown files, or start a fresh document. The file tree appears on the left; the right sidebar starts closed, so most of the window is writing space.

  3. Write your first document — files, tabs, and auto-save a moment after you stop typing, with a dot on the tab until it lands.

  4. Format without leaving the keyboard — slash commands insert any block; the markdown syntax fades as you leave it.

  5. Link your notes together — wikilinks, tags, and backlinks are what turn a folder of files into something you can navigate.

  6. Make the folder a vault — a vault adds vault-level settings, its own journal directory, and links across vaults.

  7. Turn on AI (optional) — bring your own provider and key, or keep everything local with Ollama.

Browse by topic

Section titled “Browse by topic”
Getting startedInstall, first launch, and a tour of the window.
EditingFiles and tabs, formatting, slash commands, source mode, find and replace.
Rich contentCallouts, math, code, diagrams, tables, images, videos, query blocks.
Linking & navigationWikilinks, tags, @dates, block references, backlinks, and the graph.
Vaults & workspaceVaults, folder access approval, external files, and perspectives.
TasksTask syntax, repeat rules, time tracking, and the Tasks panel.
Reading PDFsRead PDFs in a tab, highlight passages, and cite them from your notes.
AI featuresConnect a provider, edit inline, chat with a document, and run Skills.
Journal & ZettelkastenDaily notes, templates, photo journal, memories, and Zettelkasten.
Git & version historyGit source control and automatic file snapshots.
ExportHTML, PDF, Notion, and Pandoc formats such as Word and LaTeX.
CustomizationSettings, themes, the command palette, language, and Vim mode.
Using pluginsTurn plugins on and off, and see what each one is allowed to do.
Plugin developmentWrite, bundle, test, and publish a plugin of your own.
FAQShort answers, grouped by the part of Baram they are about.

Frequently looked up

Section titled “Frequently looked up”

Beyond the docs

Section titled “Beyond the docs”