README file from
GithubLanes 🎳 an Obsidian kanban plugin
Bowling, swimlanes, you get it. For Bases.
Use
Requires Obsidian 1.10.2 or newer, with Bases enabled.
- Open a
.basefile. - Add a view and choose Lanes.
- Use the board bar to set group-by, title, cover, card order, link fields, monospace, badges, worktree fields, width, and position.
- Visible card fields come from the Bases Properties toolbar.
- Drag a card to move it. Drag a column title to reorder lanes. Collapse a lane or add a note from the column header. Right-click a header for a color.
- Click a cover or screenshot thumb for a lightbox. Arrow keys step through that property.
Board options live on the view, not in a giant plugin settings dump. Plugin settings only hold defaults when a view has not set group-by or title.
If the Forest plugin is enabled, Worktree fields open that checkout's folder or preview this note from it.
License is MIT.
Screenshots
Sample vault
example/vault is a bowling-league vault with six boards (board, narrow, collapsed, areas, text, active). See example/README.md.
Install for development
Plugin id is lanes. Obsidian loads Vault/.obsidian/plugins/lanes/.
pnpm install && pnpm build
Symlink only main.js, manifest.json, and styles.css. Do not symlink the whole repo.
mkdir -p /path/to/Vault/.obsidian/plugins/lanes
ln -sfn /path/to/obsidian-lanes/main.js /path/to/Vault/.obsidian/plugins/lanes/main.js
ln -sfn /path/to/obsidian-lanes/manifest.json /path/to/Vault/.obsidian/plugins/lanes/manifest.json
ln -sfn /path/to/obsidian-lanes/styles.css /path/to/Vault/.obsidian/plugins/lanes/styles.css
Add "lanes" to Vault/.obsidian/community-plugins.json. Reload Obsidian. Turn Restricted mode off (Settings → Community plugins) or the plugin will not load.
Scripts
pnpm check
pnpm dev
pnpm build
pnpm release -- patch