Giter VIP home page Giter VIP logo

obsidian-quiet-outline's Introduction

Obsidian Quiet Outline

An outline plugin makes headings easier to read.

中文文档

Features

No auto-expand when editing

Default Outline:

系统自带大纲

Quiet Outline:

安静大纲

Search support

支持搜索

hide irrelevant results: 隐藏结果

use regex: 正则搜索

Markdown render support

渲染markdown

Auto expand and collapse

自动展开/折叠

Level Switch Bar

切换展开级别

Default level

默认级别

Drag and modify note

拖拽

Navigate in Canvas

Canvas

Navigate in Kanban

Show content when hovering on heading

Popover

Remember State

Memorizing the expanded title state when switching between open notes

Limitations

  • Due to the lazy-rendering strategy of built-in editor (Only text showed in the current window is rendered. If scrolling too fast, you will see some text is not ready to be rendered and the editor stutters), sometimes you can't jump to the place you want by one click in edit mode,especially when the note is opened for the first time since you open obsidian app. Outline core plugin has the same issue. Solution: Just click again.

  • Cross-level is not supported, which means you can use h1->h2->h3,but not h1->h3->h4, while h3 and h4 will be treated as h2 and h3.

  • Can't drag heading into a leaf heading

  • Some extented grammars in obsidian are not supported by default. But we can extend the markdown-parser to fix it! If you believe any grammar is frequently used and should be implemented, create an issue to discuss about it.

Usage

Open command panel and input Quiet Outline ,then press Enter .

For markdown-rendering, open Markdown Render option in setting panel.

Install

Download from github

  • Download the latest release.
  • Extract and put the three files (main.js, style.css, manifest.json) to folder {{obsidian_vault}}/.obsidian/plugins/obsidian-quiet-outline.

Install from Plugin Store

  • Open Settings > Third-party plugin
  • Click Browse community plugins
  • Search for "Quiet Outline"
  • Click Install

Buy me a coffee

If you enjoy this plugin, feel free to buy me a coffee.

obsidian-quiet-outline's People

Contributors

emisjerry avatar guopenghui avatar twherzog07 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

obsidian-quiet-outline's Issues

New sidebar focus breaks plugin

Recently Obsidian started allowing you to treat the right sidebar as your current focus pane. This Quiet Outline impossible to use. When I toggle controls on Quiet Outline, it thinks the focus note is the plugin tab itself, and shows nothing. When I click back on my note, the controls are reset.

To see reproduction and behavior, see this video:

https://forum.obsidian.md/t/new-sidebar-focus-has-made-some-plugins-unusable/39056

Windows 11, Obsidian 0.15.2, plugin version 0.3.1

面板仅在右侧打开

抱歉我的中文不好,我正在使用谷歌翻译。

如何重现:
1)将插件图标从右侧面板拖到左侧
2) 激活“安静轮廓”热键
3)插件移动到右窗格

这是一个小错误,但很高兴拥有
谢谢你制作了这么酷的插件

Heading levels reset on launch

I'd like to use the outline as fully expanded on all levels by default. Without the Level Switch Bar, when I reload the app only the topmost headings show. With it, the slider resets to h1 on every reload too.

don't show "no data"

showing "no data" feels like there is something wrong, but it's just because we don't have a header, which is very normal. I suggest we can remove this~

希望增加一个颜色的设置

插件很好用,解决了我的问题,非常感谢!
有一个个人喜好的问题就是现在颜色太花里胡哨了,我个人不是很适应,希望增加一个颜色的设置。。

Feature Request: show where you're at in outline

In Typora or HackMD you can see the position you're at in the outline pane, which is incredibly useful when navigating through long notes. Is it possible to add this feature to this amazing plugin?

screenshot of Typora's implementation
image

HackMD's implementation
image

标题中的序号不显示

在标题中如果存在“1. xx”的话,只会显示 xx,如图所示,不开 render 的话可以显示,但是带网址的就很难看了。请问能否解决?
Snipaste_2022-04-02_10-52-06

FR: Add Context Menu on right-clicking the Outline's Headings that gives an option to open the "Rename Headings" dialog box

Currently, we need to scroll/jump to the specific heading, and right click in the Content Body to rename a heading.

With this FR, we can simply right click on any heading from the Outline pane itself to rename that Heading seamlessly using Obsidian's native "Rename Heading" dialog box. That way, renaming headings will become super fast and efficient.

Also, if Context Menus are possible, we can also think of more options to be added inside it later.

References: https://www.naiveui.com/en-US/dark/components/tree#node-props.vue

两个功能需求

【1】目前能一键折叠大纲,希望也能一键展开所有层级。
【2】大纲层级线。
【3】文章内容很多、大纲层级很多的时候,我就想给一级标题上个颜色或者加粗之类的,这样一看就知道繁杂的大纲分为多少个大块。

增加高亮的自定义选项;跳转后高亮显示标题

@guopenghui


建议

  1. 希望Quiet Outline的高亮色能支持自定义,例如增加开关控制是否使用主题的醒目色(Accent Color)
  2. OB默认的大纲在跳转后会高亮显示选中的标题,目前Quiet Outline似乎没有这样的效果,希望作者能支持

环境

OS:win10
OB:V0.13.33
QO:0.1.2

最后

很有潜力的插件,待完善之后可以作为默认大纲的上位替代😁

Trim heading (Stop soft-wrap)

Hey there! Just installed the plugin. Is it possible to trim headings in the outline? Right now, all the heading flow to the next line (aka, soft-wrap is enabled).

It stoped working

After I updated to Obsidian 0.15.6, clicking on any header in the sidebar does nothing. It doesn't jump to that header in the file editor.
Please help.

Shortcut for refresh button

First, I just want to say how good the plugin is !
图片
Add shortcut key to the refresh button show in above image ?
Refresh button can be frequently needed, i.e. a handy shortcut can be extremely helpful.

Does it work?

I installed the plug-in and enabled it, and reloaded Obsidian. This is a header in the main text of a note:

image

and this is the same header in the Outline:

image

Using markdown (e.g. **text**) is also rendered with asterisks in the Outline.

Option to turn off search input box and other button.

First of all, thanks for your work.
I'm kind of "ocd", could you add a option to turn on or off other functions? I wanna remove the top button that I barely use.
image
I'd appreciate if you take my issue, while it's fine if you're too busy to do it.
thanks again.


首先非常感谢您开发的插件。
我有点儿强迫症,能不能增加开启或关闭其它功能的选项?上方的按钮我几乎不用,所以我想去掉。
我这个要求比较小众,您要是开发忙可以不用管我。
再次感谢。

Remove color from reset button

I don't really see a reason for the reset button to be colored green and call attention so much. It clashes with the rest of Obsidian. Can it be changed to monochrome?

Reset button moves pane

I don't keep my outline in the upper right sidebar, so this makes the reset button unusable.

reset

给作者大大提几个小优化需求

感觉这插件要火🔥
提几个需求:

  • [[|别名]],链接别名作为标题在大纲中的优化(如图1)
  • 大纲对齐线的需求(如图2)
  • 显示大纲面板的快捷键设置,毕竟屏幕就那么点,快捷键切换文件目录与大纲目录还是很常用的(如图3)

望考虑,感谢兄弟提供这么好用的功能

image

image

image

[Appearance] Invisible text in light mode

Plugin works amazingly on dark mode, but the text is invisible on light mode of any theme (tried on Sanctum, Minimal, and default).

Would really help if it could be fixed :)
Thanks

image

FR: Add a count of headings

There are two feature requests in this issue:

1. Show Count of each type of H2, H3, H4, etc.

UI: You can add this as an overlay on the sliding component's each level's dot.

Why: To easily know how many headings are there on the page without counting them manually.

2. Show Count of filtered Headings

UI: Add a count of the filtered results, beside the search input box.

Why: Extremely useful for long pages with hundreds of headings. Even after filtering, I am left with dozens of headings. That way I don't have to scroll and count through dozens of headings manually.

Headings collapse even when forbidden

Even with expand level set to H5 and auto expand and hide unsearched turned off, headings are collapsed sometimes. It looks like with H5 expand level, H2 headings are collapsed for some reason.

Filtering is not effective

When i try to filter, it just open up some folding, not eliminating any results. like i am having a lot of level 3 heading I use to index stuff and i can find anything because there is no filter applied.

thank you, such a plugin was really needed

默认展开全部层次+调小子级标题字体大小

很好用的插件,谢谢作者。想反馈两个小细节:

  1. 能否默认展开全部层次?或者增加一个命令按钮以一键展开
  2. 想调小子级标题字体大小(如下图所示),请问应该如何写css?谢谢
    image|100

大纲自动滚动

  • 文件名滚动效果:

当文件名过长时会滚动显示
image

  • 希望大纲中也可以加入滚动效果:

image

Clicking on header doesn't jump to position in Obsidian v0.15.6

Before the feature works great, and even now on my other computer that still is on Obsidian v0.14 it works fine as well, but something seems to have happened on a recent version that breaks it so clicking on a header doesn't jump to that position in the editor.

PS this is a great plugin, much prefer this outline over the obsidian default.

Bug: can't interact with Quiet Outline in standalone window

With the new update, I use multiple Obsidian windows across Virtual Desktops, but only the main window can have expandable sidebars. The temporary solution for me, is to move the sidebars contents into a new window, which then can be accessible over all Virtual Desktops. But there is a bug with Quiet Outline, is that, when it is in standalone window, you can't interact with it. The core plugin doesn't have this issue.

Besides fixing the bug, another way to solve my issue navigating with Quiet Outline with absence of sidebars is would be the ability to open a new instance of Quiet Outline in each window as the new pane. I'm not sure, if it is worth it to implement for now.

建议固定搜索框

现在下滑时搜索框也会跟着滑走, 要搜索内容时, 得重新滑到顶部才能输入内容, 希望搜索框能固定着, 不管目录下滑到哪个标题都能看到搜索框, 这样想搜索随时就可以搜索

感谢开发这么好用的插件, 里面的一些功能英文论坛里有些人都提了好几年了, 希望更多人能知道这个插件的存在

FR: Auto Scroll the Outline to always keep current `.located` class Heading within view

Issue

Currently, the plugin adds a new .located class to a heading based on Content Body's scroll position. That's great. We can customize it in CSS snippet.

But, on a long page containing hundreds of headings, such .located heading quickly goes below the view. The issue is that when the Current Heading goes out of view in the Outline, it's hard to know where you are in your long document.
So, we have to manually scroll the Outline again and again.

It would be great if such Current Heading (with class .located) stays in view, i.e., the Outline pane is able to auto scroll.


It can be something along these lines:

function keepTocInViewMethod() {
  const tocNavEl = document.querySelector("#yourOutlineDivWithScrollbar");
  const tocItemEls = document.querySelectorAll(".n-tree-node.located");
  const tocItemEl = tocItemEls[tocItemEls.length - 1]; // last item

  if (tocItemEl && tocNavEl) {
    let tocItemElOffsetTop = tocItemEl.offsetTop - 300;

    tocNavEl.scrollTop = tocItemElOffsetTop;
  }
}

And call this function on the scroll event, i.e., whenever the Content Body is scrolled.

  • You can dabble with debounce too if it gives better performance.
  • Also, you can add this event listener only if there are over, say 10 Headings on a page, i.e., 10 .n-tree-node-wrapper elements.
    if (/* There are over 10 headings */ <Headings>.length > 10) {
<TheContentBodyElement>.addEventListener(
        "scroll",
        _.debounce(keepTocInViewMethod, 1000),
        null
      );
    }

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.