Getting started
Getting Started
Section titled “Getting Started”Installation
Section titled “Installation”Download the latest release for your platform from the Releases page.
| Platform | Format |
|---|---|
| macOS (Apple Silicon / Intel) | .dmg |
| Windows (x64 / ARM) | .msi, .exe |
| Linux (x64) | .deb, .AppImage |
Alternatively, build from source.
First Launch
Section titled “First Launch”When you first open Baram, a Welcome screen greets you with two options:
- Open Folder — Open an existing folder of markdown files
- New File — Create a fresh document
Interface Overview
Section titled “Interface Overview”Baram uses a 3-column layout:
Context Tab Bar
one tab per vault or folder
Activity Bar
Left Sidebar
File tree · Backlinks · Search
Document Tab Bar
Main Editor
WYSIWYG
Right Sidebar
Outline · AI chat
Status Bar
- Context Tab Bar — one tab for every vault or folder you have open. It spans the full width at the very top of the window, and hides when no vault or folder is open.
- Activity Bar — the icon strip that chooses what the left sidebar and the right panel show. Pick which icons appear, and in what order, under Settings > Activity Bar. It hides when no folder is open.
- Left Sidebar — File tree, backlinks panel, bookmarks, global search, Git source control, and version history. Toggle with
Cmd+Shift+L(macOS) /Ctrl+Shift+L(Windows/Linux). - Document Tab Bar — the documents open in the current context. Drag a tab out of the bar to tear it off into its own window.
- Main Editor — The WYSIWYG editing area where you write.
- Right Sidebar — Document outline showing heading structure, or AI Chat panel.
- Status Bar — Shows word count, line count, and cursor position.
The left sidebar opens with a workspace and the right one starts closed, so the window stays mostly writing space. The editor follows the principle of minimal interface — only showing what you need, when you need it.
Help Menu
Section titled “Help Menu”The Help menu opens this guide, the keyboard shortcut reference, and the FAQ in your browser, plus links to the project homepage and issue tracker — there is no in-app panel:
| Menu item | Opens |
|---|---|
| User Guide | This guide |
| Keyboard Shortcuts | Complete keyboard shortcut reference |
| FAQ | Frequently asked questions and answers |
| Baram Homepage | The project homepage |
| Report Issue… | GitHub Issues |
Getting Help
Section titled “Getting Help”- Help Menu — Opens the User Guide, Keyboard Shortcuts, and FAQ in your browser
- Command Palette (
Cmd+PorCmd+Shift+P) — Search for any feature - Quick Switcher (
Cmd+K) — Quickly open files and jump to headings - Slash Commands (
/) — Quick block insertion - FAQ — Frequently asked questions
- GitHub Issues — Report bugs or request features