README file from
Githubobsidian-bullet-list-outline
An outline plugin for Obsidian that supports bullet lists, headings, and canvas.
English
A simple sidebar outline plugin for Obsidian. It provides a tree-view outline for unordered lists, document headings, and canvas files.
Recent Updates
- Outline Toggle: The list outline mode can now be enabled or disabled via document properties (frontmatter).
- Outline Switching: The sidebar outline automatically adapts to the active document, supporting Heading, List, and Canvas outlines.
- Level Management: Added global settings for default expansion levels and sidebar controls for custom expansion/collapse.
- Navigation: Added "Jump to Top" and "Jump to Bottom" buttons in the sidebar.
- Display Adjustments: Added custom color options for the light theme and the ability to truncate heading display lengths.
Core Features
- List Outline Mode: Unordered list items are displayed hierarchically with heading-like visual styles. Simply add cssclasses: list-outline-mode to the YAML frontmatter at the top of your note to enable it.
- Outline Switching: The sidebar automatically adapts to the active document, currently supporting Heading Outline, List Outline, and Canvas Outline.
Installation
Note: Requires Obsidian v1.4.0 or higher.
Community Plugins
- Go to Settings > Community plugins.
- Turn off Restricted mode.
- Search for Bullet List Outline and install.
Manual
- Download
main.js,manifest.json, andstyles.cssfrom Releases. - Place them in your vault under
.obsidian/plugins/bullet-list-outline/. - Reload Obsidian and enable the plugin.
Contact & License
- Issues: GitHub Issues
- Email: [email protected]
- License: MIT
Acknowledgements
- This plugin was inspired by obsidian-quiet-outline.
中文说明
一款 Obsidian 侧边栏大纲插件,支持显示无序列表、正文标题以及白板(Canvas)的结构化大纲。
近期更新
- 模式开关:支持通过文档属性(Properties)直接开启或关闭列表大纲模式。
- 大纲切换:侧边栏自动跟随当前文档适配,目前支持标题大纲、列表大纲和白板大纲。
- 层级控制:新增全局默认层级展开设置,并支持在侧边栏自定义层级的展开与折叠。
- 快速跳转:侧边栏新增“跳转至顶部”和“跳转至底部”功能。
- 显示优化:支持在明亮模式下自定义外观颜色,并支持自定义或限制标题的显示长度。
核心功能
- 列表大纲模式:无序列表项按层级呈现为类似标题的视觉样式。只需在笔记顶部的 YAML 属性区添加 cssclasses: list-outline-mode 即可。
- 大纲切换:侧边栏自动跟随当前文档适配,目前支持标题大纲、列表大纲和白板大纲。
安装方式
注:需要 Obsidian v1.4.0 及以上版本。
插件市场安装
- 打开 设置 > 第三方插件,关闭安全模式。
- 搜索 Bullet List Outline 并安装启用。
手动安装
- 从 Releases 下载最新版本的
main.js、manifest.json与styles.css。 - 将文件放入
.obsidian/plugins/bullet-list-outline/文件夹。 - 重启 Obsidian 并启用插件。
联系与协议
- 反馈:提交 Issue
- 邮箱:[email protected]
- 开源协议:MIT
鸣谢
- 本插件的开发灵感来源于 obsidian-quiet-outline.