From d1ee82fe1dc4e5049216123d22eddb958eefe556 Mon Sep 17 00:00:00 2001 From: Lost Paul <70213368+LostPaul@users.noreply.github.com> Date: Sat, 21 Jun 2025 12:48:07 +0200 Subject: [PATCH] Add settings documentation and update index page Added new documentation pages for File Explorer, General, and Path settings under Features/Settings, including a related screenshot. Updated the index.md to improve feature descriptions and clarify plugin capabilities. --- docs/docs/Features/Settings/File explorer.md | 32 +++++++++++++++ docs/docs/Features/Settings/General.md | 5 +++ docs/docs/Features/Settings/Path.md | 22 ++++++++++ .../screenshots/Obsidian_LaoyRX8jr2.png | Bin 0 -> 14570 bytes docs/docs/index.md | 38 +++++++++--------- 5 files changed, 79 insertions(+), 18 deletions(-) create mode 100644 docs/docs/Features/Settings/File explorer.md create mode 100644 docs/docs/Features/Settings/General.md create mode 100644 docs/docs/Features/Settings/Path.md create mode 100644 docs/docs/assets/screenshots/Obsidian_LaoyRX8jr2.png diff --git a/docs/docs/Features/Settings/File explorer.md b/docs/docs/Features/Settings/File explorer.md new file mode 100644 index 0000000..c52b6d0 --- /dev/null +++ b/docs/docs/Features/Settings/File explorer.md @@ -0,0 +1,32 @@ +# File explorer settings +### Hide folder note +Hide files in the file explorer which are linked to folders +### Disable click-to-open folder note on mobile +Disable the option to open folder notes by tapping on the folder name of a folder with a folder note in the file explorer. With that option enabled it's only possible to open folder notes with the command palette oder the context menu. + +### Open folder notes by only clicking directly on the folder name +With this option enabled you can only open a folder note by clicking when doing so exactly on the folder name and not on the whitespace around it. When you also have "Disable folder collapsing" enabled folders also won't collapse when you click on a folder name. + +### Disable folder collapsing +Stop folders with folder notes from collapsing when click directly on the folder name or on the whitespace around it. Except when you click on the collapse icon you can still collapse folders. + +### Use submenus +When this option is enabled and you use the context menu for folder/files at first you can only see "Folder Note Commands" in the menu and you have to hover over it to see all options. + +## Style settings + +### Highlight folder in the file explorer +Normally only the file gets highlighted in the explorer but when you enable this option the folder of a folder note gets also highlighted. + +### Hide collapse icon +Hide the collapse icon next to a folder name for a folder with a folder note or also for every folder with no files. + +### Underline the name of folder note +Underline the names of folders with folder notes in the file explorer. + +### Bold the name of folder notes +Bold folders in the file explorer that have a folder note. + +### Cursive the name of folder notes +Make folder with folder notes in the file explorer cursive. + diff --git a/docs/docs/Features/Settings/General.md b/docs/docs/Features/Settings/General.md new file mode 100644 index 0000000..dff0a42 --- /dev/null +++ b/docs/docs/Features/Settings/General.md @@ -0,0 +1,5 @@ +# General settings +### Folder note name template +The entered text is going to be the name of all folder notes and when file name matches this text it becomes a folder note. {{folder_name}} is a placeholder for the name of the folder linked to the file. If you change the text every existing folder note which matched the old text won't be a folder note anymore and you have to use the button "Rename existing folder notes" to rename all folder notes. + +This page will be finished soon. \ No newline at end of file diff --git a/docs/docs/Features/Settings/Path.md b/docs/docs/Features/Settings/Path.md new file mode 100644 index 0000000..fe433a8 --- /dev/null +++ b/docs/docs/Features/Settings/Path.md @@ -0,0 +1,22 @@ +# Path settings +The "path" is the file path above a note in the editor. + +![Screenshot](../../assets/screenshots/Obsidian_LaoyRX8jr2.png) +### Open folder note through path +Open a folder note by click on a folder name in the path when it has a folder note linked to it. + +### Open sidebar when opening a folder note through path +Disable/enable if the left sidebar should also open when you open a folder note through the path. + +### Auto update folder name in the path ([front matter title plugin only](https://github.com/snezhig/obsidian-front-matter-title)) +Automatically update the folder name in the path when the front matter title plugin is enabled and the title for a folder note is changed in the front matter. This will not change the file name, only the displayed name in the path. + +## Style settings + +### Underline folder in the path +Underline every folder with a folder note in the path. + +### Bold folders in the path +Bold every folder with a folder note in the path. +### Cursive folders in the path +Make every folder with a folder note in the path cursive. \ No newline at end of file diff --git a/docs/docs/assets/screenshots/Obsidian_LaoyRX8jr2.png b/docs/docs/assets/screenshots/Obsidian_LaoyRX8jr2.png new file mode 100644 index 0000000000000000000000000000000000000000..18bf86f034006813a06d88ce15ec0614fb6cae81 GIT binary patch literal 14570 zcmeHud010P*7s$RWn>%aQIsu?qjnD}Dr!WQfEzlZpwb{~P+As&MA^3xAPU+l=%}Ew zL>mzx|sOqtp0{_qsb3N$_ z05y55<>yy{f9qd9<{JwDMs4aJjSl3?9{^xK`uJg2ucRO@Q&uq|Mor8sbt59qTD<(G z%&P{K_Ue*<%!nSI6@@^o;fx1;-Tbm4-_-nXKR&$^HFo&K)q-y$zMQ~>d%9K(w|=T^ zcxN$or1uC(Bh&Tg%jeo8$>K6av?`OfP#im6#7~2<8!fx-AIApeSz8?r8+TwcZsmv+ zMUozzB`m!eWDlTn7kdvGKalZAxRK?izybnR%XuJtywf{u0?N*9xlFg`*qe|>j%!419W#u?4AuHrGGvC{ssPJLC* zc7Xat7mZD>X-*ejY8)0xZ*o2|IVr{8;Q~-C%}bAXTt-iG453-c^zb2C|D%H(_oB$r zn@t}5$oZL$%l9dnVv#dq?UHy~idFNBlJ~(1++-oxGV;M!3 z(kShGG%aeQHSg|-tn&~w6*p5th)$)xSVpJ=ejBv=4IA9Cd{4pljL>Sfavyb06l%sE zp@)+<_M)Opwa79i-ZZq2yrP*We0^{p!!gx-=7A6>%_TM zw#6a#u(N?CF|OH(m)u-*Ahy;TLz>lby>fpF?_$vgYEt9 znY&ph&0PD1m7C^Xn4B&up(>ET$`7F%fHHHs|&Y$kdoPUy(k2r?18P6vH9=lQ*UOn=oBrq3ziM2EkBvfRsFxb&}h zS^fMWNiwawpHmTHPT@ZCnwcR{l9h?o#ao^^3X^=NSghR%-%|J(stEcGI6djN>5scU zna5)luN@VO9|yQ<7E&YV7;5d?rlQ`-xtI?SLj2UzbtElX=tB~L zEDC|p-k`11MbwoPwhdKgPJHGMN>g-5ijBc>vVo8$j6wtm$^aH~kgi*>kVqQKogJ(gF)u8CRrPST)lZFY<{-G2}ck73y zRQ6BYOD0QWFy+`n7+Ms@iG<6Bz4Dx;;licjOC@zYDd{oFA%5CRvRH;xsFHMmA&<4r zOEc*QQzGwtvV4qqsr$UGHC(m8%?xvrM_JiP=1Zqrx$iDFY>|v-gaF%bwsS`52zancg_% zB7C(_(nYV!XImv1!QKZl%wC9$y~}uKQ_(3p#8O#rY;z%YylU}vn3v!?@p0G|$34o1 z$BM^$?(?iXoE%HG>bX0sTH3^yP-C}X?augX_jk$q&Gh#<{jnG%GWBbWOEg9{)3I-Q zqMZG@>m+^-bdDLD>t4G)k%YS7;S)40j^|$oF5~uit>ejWl9onuDrAU)@ij-gkCRnO zS%nOYolVz_mF4HBJQKs4B7QJ);F@ci6A6@!o|VX9(a}W%cvaSDrr6K=d^1v*YgBl7uK! z+n6NFC4R@SPF^%t)g5b(ko*B&ISQjlsa8#BpS)Kz6e{BN zdp=+)1z1u7YS^_#JJ?pHV8D*DNo+yvgEny1d zb0lNgRb%yZ%g0FL+MH?7v^sjIiSjE6d$2KBX~-MP!b4xA4LPCv>${&S5&~XY+oePa z?Jdzt#teI;-R>UToH5N^EVO%O5Qi=7v7crn&>~aD1+~e}Lm?PQ?}uuJ*l_QzC&>Yc#Wycc6ek+h%O26v zUNj;5z$maM`}F5`cQ*~7NR<*xtz97O_>5e?hfc*R&hnxnz)fS_dE?#;I`Qwa+Z0t> zzLCo(VAgVe9$G#&tvqUK*fisRHLN5#bjIx(zj2~uT6tvnBcvCMJ(nG_T=0R*1o@&u zVaL^}$KbC=Saqmo&M~xL@=@aoSpoyAoWdH_EAC$htAX8`+*G>G9G?B?9yi@D8Vwyk?vOy~+&_PV{IxEy-Ukp7k z@q41}<3C6J5u+R<%W_0WqCQCcyn!-f2Y)pHtp78F$S}wPQI8o0_M}Uu3ApHhunXdz zIG6YpWGi2zHjcfnNvs82-l>LR=au5pyj%n2DQ3J6!QjqVYaYrSL}hv#mobnn2t^E4 zKsLh4!MgN><#fSElEWl$5Xl*8XF7HxZ_3L^ynk9ty4kN;;0EpAukPuYIC8~J za+|$$d*P`uN>5KbLs8Cfh-ewHLaYxO_S*jjOJ)Gz+SN^49d*D4$$%_B0S%C>y6LIm z9oYU`IJ!at1ew1<^Z!y7)Yj^l@_;1SQC~RRx*?hSujEm@Q&;!&lnrNmys5r9@p%z% z2hk@#8V!m$1LbA{T#suCNXFR(1W|me9GQVtW6uYALI%5}4ihsR1O`uO@Z~cIt2u{h zwRXPs8uBV0?O*oEyvn;m9JxPGoih#bwKX!1>DuZQq03SoXD%u*0}CxB7sF~Rw3aM~ zDi!O~@IU2#x4iWhj#+@qGsRl%+(a;J zmQG}$uvVnJ9m8E`TYxVPdHuR*TNwNmjn+Mbe6YGKuZIE~+cR+?Is_ZEB<*XBo?ySC zVIUy$fNmZHFp0>+P&@IQFTy@o$#rAI{S#sJy5p!eMGYd=7Wh$#q6QADP^NCkIu*9Y1{vWlN=KucQkmL%Tb!co=GWjyBl$^=FF**)QYf1o^rP6k9Ecxv@;US zw5t^1u>kqv^E5torb}-?OHLMUKW;MFNMW%aMw45v^aL$kL>UdT?BS=pX7&e^$dhT$ zZ!EjRU?a7$lx!3>v?eifv#5la^Us6m?{Cs8;s>;ZAQ?B4{qrAFRAC8<3--xNhiROw z!A^hn)Te^=q6zP1<-6kw+IK(H3~pNio7@2{PtytxR|78PH$3VzHBCA~YL${~QnwDS6yl9NBYM$#Vu_i=2_bJb%HiFYS7;DnIx;8OJ zdZABn^u+RjroKS7U$OuU@K6fukoDjLLnsSb2}l1^I$dSjWMV}>)6}qCt$6BxE_ChCzhvh$oRp0AaY?*|X$ z=Hp=$mO1j*T~yCmZ3;WbwcbPf3JQ5EGhSr)9=Tbs=v%dxq6*c zQ(A!SA4<-R<)o?{Lti@e`T3%zVx4CE<4pDkoRUxa5k{^jj)MZjqVZOXM8llfvlth_ zD^*z6gXuMg@5SqK%T!PKXWR({bLe!^M<&*CjXG9C)Ru#MvpGWAjBW`?QHIk}HrzDU z?7oQEp(rQyI7t6tIh{$+>;j=Mfg$!)!fnXi}QIN}TM* zl(QMX>ld)kaq)-b(Ff2jg1PYGr9l=Lf+(`kWC?DVUeCvygIKc(3wpZbiU2guE(z{$ z14YksTX*AiGu!)Oq`E#j9S0U3j_-EjlLJoe>-qp@r{0}6>?XP%5OD>C-4|~)&7|>D z8bvn?x>m!j*PSscC@rHE*zgf>zn6WEyh@**{ChS69xZKor{4Yl4L+#k7-g}rmhAlg zl093{aKs)Z8J`q^erdZFr~uWsKpBZ@1Q+8`EhEioO%r7Qni|$X!BM33+YE8l{f}*o z67m_ukD6d#sxxTVJMV?S51j2OviHpujwH%vub3oF$rB9BSo@aRsl0TXWqbT9NOTKn zVm@a2!=spm`EfKJnYKV3r7;I$ehV)F_?v!7A-c9@5aOP0i~=5Q*Nc*;yR>Wvzt6b%50Lpn)EaFajH={>{FZ!)KNsWb)J32> zIO|2FuRi}}x0rl$xoeL*1%41+ppc)SP`q>ba>yti#zhDb!q~({}Dtk_gKN?EBOhi2rIc7@LwicD>kx{!>^oY zti%z}5B%pl(-nWQf-ltJVMQ;1m4n=sLv6JwtRxdF$pokdE6K!4G6AZ=%HhKbH~`gP z1stq^15gcCz`;r-gjx+&z`+VQ0M%dx9Q?lr4ytJ*@$^8>WM8Se#(hUep0)178xXb8 z1G2YwH@S5lGIrW?T|>-Fgg1ikEp&CjlvgqyEtfC=)y9rNZ-LL=zg}=vzs-h0Ml5GFKAc#7ks)LAKDovyFW5LZ z=(piD<3ueUS;o6m-N8DLDw=f>Ckz?dVC9MhY60wYt|Dh^r*%sP~(CVgOQ>I^C@@@FOn+ObJRHH=AVfNZ^9x}^ST!UY}a|eQN zYKwN#Ht&--_Aa`oL4Gnp#Me6G5Z{p^dq=MK;I)6v2_+f-;T|afxNz zv?cFfA~oVjaph+VWCgiz#b*{B3XA&ETyRn_n-|scQ=N>fJKpK(h&owjN8Psjd5uxdxvx2v-tG z@>7Oiy3Hp#8yN?_L4G=I(mJRHeG zo?Tdq5x+VlMMkF`K+R3@pgj+^`gPS&B6?ep)vO-WCdLLye=6$zlTjdPj7>Alt~H;D zG%Rq-qPBldh=lEq6bU7><_xx&W{ z!G|ZLcRxW76SW?n&?c0+nrb~p>cnY>+K|ZEL&6uhN z6sVeT7Em+Hn2#gmU7WoV4?iJ9uVXM?^9$>6f(>BRw?sVG zajoz?TEHip^_sC*|2JC`_r7X{=;k}Mb@z<9*-~~}42z;lNoj-@`z#lbBb2n6gl&sA zvQ_-jf=nmcsk!Q{*?V6(STUfg*HsQ2@SDJIcp^4@FGCb|40Yt8nO+^N8|M_bwvw^+ z2nu2LZLD4II&Hr^YhMpG+U{PESP+qJ(XgIpjQ&TG*{bZOT~GQ(1`}ofA*xRp7sb^0 zrSJoxpN_YU-N62v7Ztg9X1lN+tg|Vk6Rhprc~z-ph%ke2uZgFTf@Vjt!UvigKf{L} zwbk!ORZYmVT?ikF+F|K(ftRJs9oHr$PbY1$l;x8l)p+{wQuK#VGhkRtNoHhcYdmd? z@)VOJez#ows!X0|%r8K!;9jqPS8fm%6?e>^O;6mu#EnL7gCSt!MwMAdM;KW`y1#d<7X@B z)Mxbb;-n^Y-qlyU#z%AJn(@6G9xt-bdfXYx9KDDMUBAFz)V*f@yYBd6sDnGxr#W%^ zathhVzzfgA&NW|Qn{x)nbE5nYFIJW