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
No description
45 commits 1 branch 1 tag 200 KiB
TypeScript 97.6%
CSS 2.4%
Find a file
Unarray ca320c7d34 Remove 📁 icon from name
2023-10-03 11:51:14 +02:00
.github/workflows Update github action workflow 2023-09-21 13:06:53 +02:00
meta Update README.md 2023-09-21 11:54:49 +02:00
src Use obsidian built-in sleep function 2023-10-03 11:50:39 +02:00
.gitignore Init project 2023-08-23 14:02:57 +02:00
LICENSE Initial commit 2023-08-23 13:59:17 +02:00
manifest.json Remove 📁 icon from name 2023-10-03 11:51:14 +02:00
package.json Remove 📁 icon from name 2023-10-03 11:51:14 +02:00
README.md Remove 📁 icon from name 2023-10-03 11:51:14 +02:00
styles.css Add plugin skin 2023-08-26 18:32:17 +02:00
tsconfig.json Init project 2023-08-23 14:02:57 +02:00
tsup.config.ts Add ignore library 2023-08-26 18:07:29 +02:00
versions.json Add plugin manifest.json & versions.json 2023-08-23 15:59:17 +02:00

README.md

File Tree Generator

An Obsidian plugin allow you to generate file trees using Obsidian Callouts!

obsidian dark-mode example obsidian light-mode example

How to use?

When editing an Obsidian note, you can use generate file tree command or use the generate file tree Ribbon Icon.

generate file tree pannel

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.
This patterns follow the gitignore spec 2.22.1

generate file tree pannel

Note

This plugin use FS (desktop only) to load files from your local directory.

Installation

In your vault folder, go to ./.obsidian/plugins/file-tree-generator/ Then you can:

Clone this REPO and run npm run build or directly download latest plugin release containing main.js, manifest.json and styles.css.

Note

If you are a developer, clone this repo -> run npm i -> start coding with npm run dev (to hot-reload the plugin in obsidian, install Hot-Reload plugin)