README file from
GithubPlaydown
Playlist-based note navigation for Obsidian. Create playlists, navigate notes sequentially, track your reading progress, and manage your flow from a dedicated sidebar panel.
Playdown turns a set of notes into a "playlist": add notes to an ordered list, read them one by one, mark your position, and jump back at any time. It is built for sequential reading workflows such as reviewing a series of notes, reading a book chapter by chapter, or working through a learning path.
Features
- Playlists: create, rename, and delete multiple playlists; import a playlist from
[[wiki links]]in the current note; export a playlist back to Markdown. - Sequential navigation: previous / next / play from start, with an always-visible progress indicator for the active playlist.
- Reading mark: mark the current note and move forward, then return to the marked note whenever you like.
- Queue ordering: reorder notes by drag and drop, or from the keyboard with
Alt+ArrowUp/Alt+ArrowDown. - Sidebar view: progress bar, current note, playlist management, and queue controls in a single panel.
Usage
Commands
| Command | Description |
|---|---|
| Open view | Open the Playdown sidebar panel |
| Create playlist | Create and activate a new playlist |
| Add current note to playlist | Append the currently open note to the active playlist |
| Previous note / Next note | Navigate backward or forward within the active playlist |
| Mark current note and go to next | Record the current position, then move to the next note |
| Return to marked note | Jump back to the note you marked |
| Export active playlist to Markdown | Generate a file with one [[link]] per line |
| Import playlist from current note | Parse [[wiki links]] from the open Markdown file into a new playlist |
Quick start
- Open the Playdown view (ribbon icon or command palette).
- Click "新建播放列表" (Create playlist).
- Open a note and click "添加当前笔记" (Add current note).
- Navigate with the Next/Previous buttons or commands, and use "标记并前进" (Mark and forward) to save your position.
The plugin's in-app UI is currently localized in Chinese. Command names are in English so they can be bound to hotkeys easily.
Installation
- Community plugin browser: Settings → Community plugins → Browse, search for "Playdown" (available once published).
- Manual: download
main.js,manifest.json, andstyles.cssfrom GitHub Releases into<vault>/.obsidian/plugins/playdown/. - Beta testing: install with BRAT.
Development
npm install # install dependencies
npm run build # build main.js
Source code lives in src/; the bundled main.js is produced by esbuild.
中文说明
Playdown 是播放列表式笔记导航插件:把笔记按顺序串成播放列表,逐篇阅读、标记进度、随时跳回。
- 播放列表:创建 / 重命名 / 删除多个播放列表,从当前笔记导入
[[链接]],导出为 Markdown - 顺序阅读:上一篇 / 下一篇 / 从第一篇开始,当前进度一目了然
- 阅读标记:标记当前笔记并前进,随时返回已标记的笔记
- 队列排序:拖拽或键盘(
Alt+↑/↓)调整阅读顺序
许可证
MIT License,见 LICENSE。