Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Quorafind committed May 14, 2024
1 parent 98ab93a commit d1999a2
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 4 deletions.
29 changes: 25 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,34 @@
## Outliner.md
<div align="center">
<picture>
<img alt="Light mode" src="https://github.com/Quorafind/Outliner.md/blob/main/assets/outliner-md.png">
</picture>
<p>Enhancing your Obsidian outliner experience.</p>
</div>

<img alt="GitHub Release" src="https://img.shields.io/github/downloads/quorafind/outliner.md/total?color=%23d12828"> <img alt="GitHub Release" src="https://img.shields.io/github/v/release/quorafind/outliner.md?color=%23d12828">

## Documentation

Visit the [Outliner.md docs](https://docs.outliner.md) for more information.

## Features

> You need to install `Obsidian Zoom`, `Obsidian Outliner` and also `Obsidian Dataview` plugins to use this plugin better.
> [!warning]
> You need to add `outliner: true` to the frontmatter of the note to enable the outliner view.
1. Support basic filter features like workflowy.
2. Support bullet list menu;
3. Improve the experience of the outliner view;
### 💭 Smoother outliner experience

Filter, hotkey and more, just like you are using outliner software.

### 💫 Embedded content editing

Embed anything and then edit it there.

### 📚 Backlink editing

Just open your note, scroll to the bottom, and you can edit the backlinks directly.

### Roadmap

Expand Down
Binary file added assets/outliner-md.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions assets/outliner-md.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d1999a2

Please sign in to comment.