obsidian-plugin/unarray_file-tree-generator
1
0
Fork 0
mirror of https://github.com/unarray/file-tree-generator.git synced 2026-07-22 08:40:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Unarray 2023-09-21 11:54:49 +02:00
parent fc40314204
commit c694ea17ef
4 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -1,13 +1,19 @@
# File Tree Generator
An Obsidian plugin allow you to generate file trees using [Obsidian Callouts](https://help.obsidian.md/Editing+and+formatting/Callouts)!
![obsidian dark-mode example](meta/example-dark.png)
![obsidian light-mode example](meta/example-light.png)
## How to use?
When editing an Obsidian note, you can use `generate file tree` command or use the generate file tree Ribbon Icon.</br>
*(if you are on desktop, you can import a folder by pressing the extra button next to your files paths input)*
![generate file tree pannel](meta/pannel.png)
> [!NOTE]
> if you are on desktop, you can import a folder by pressing the extra button next to your files paths input
---
As you see, you can ignore patterns of files/folders in the setting tabs.</br>
This patterns follow the [gitignore spec 2.22.1](https://git-scm.com/docs/gitignore/2.22.1)

BIN
meta/example-dark.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 56 KiB

BIN
meta/example-light.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 56 KiB

BIN
meta/pannel.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 18 KiB