https://github.com/brokensandals/markheadboard

VS Code extension to display a Markdown file as a kanban-like board.
https://github.com/brokensandals/markheadboard

Last synced: 3 months ago
JSON representation

VS Code extension to display a Markdown file as a kanban-like board.

• Host: GitHub
• URL: https://github.com/brokensandals/markheadboard
• Owner: brokensandals
• License: mit
• Created: 2020-07-26T23:10:54.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-03-05T08:05:07.000Z (over 1 year ago)
• Last Synced: 2024-06-16T15:42:00.928Z (5 months ago)
• Language: TypeScript
• Size: 2.12 MB
• Stars: 14
• Watchers: 3
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Mark Headboard

Provides a kanban-board-like view for Markdown files.

Each level 1 heading is a column on the board, and each level 2 heading is a card in the column.

![demo](docs/demo.gif)

Features:

- clicking a card will take you to that section in the text editor

  - if a column or card title contains links (in the `[title](href)` syntax), command-clicking it instead opens the first link

- drag & drop cards or columns to rearrange sections in the document

## Usage

Two commands are added to the command palette:

- `Mark Headboard: Reopen as Board`

- `Mark Headboard: Open as Board to the Side`

Or, you can use `Reopen Editor With`.

## Known Issues

Markdown parsing is primitive and done via regex.

Most notably, it doesn't yet know to ignore fenced code blocks when scanning for headings.

Also, only atx-style headers (`#` and `##`) are supported, not setext-style headers.

Moving the last column to the front does not work correctly if there is no trailing newline.