obsidian-plugin/lostpaul_obsidian-folder-notes
1
0
Fork 0
mirror of https://github.com/lostpaul/obsidian-folder-notes.git synced 2026-07-22 07:40:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
lostpaul_obsidian-folder-notes/Getting started/index.html

896 lines
No EOL
19 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="prev" href="../Folder%20overview/">
<link rel="next" href="../Troubleshooting/">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">
<title>Getting started - Obsidian folder notes</title>
<link rel="stylesheet" href="../assets/stylesheets/main.484c7ddc.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#getting-started" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="Obsidian folder notes" class="md-header__button md-logo" aria-label="Obsidian folder notes" data-md-component="logo">
<img src="../assets/2023_Obsidian_logo.svg.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Obsidian folder notes
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Getting started
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
</label>
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
</label>
</form>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="Obsidian folder notes" class="md-nav__button md-logo" aria-label="Obsidian folder notes" data-md-component="logo">
<img src="../assets/2023_Obsidian_logo.svg.png" alt="logo">
</a>
Obsidian folder notes
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../Folder%20overview/" class="md-nav__link">
<span class="md-ellipsis">
Folder overview
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Getting started
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Getting started
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#how-to-install-the-plugin" class="md-nav__link">
<span class="md-ellipsis">
How to install the plugin
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#basic-features" class="md-nav__link">
<span class="md-ellipsis">
Basic features
</span>
</a>
<nav class="md-nav" aria-label="Basic features">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#create-folder-note" class="md-nav__link">
<span class="md-ellipsis">
Create folder note
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#open-folder-note" class="md-nav__link">
<span class="md-ellipsis">
Open folder note
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create-folder-overview" class="md-nav__link">
<span class="md-ellipsis">
Create folder overview
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../Troubleshooting/" class="md-nav__link">
<span class="md-ellipsis">
Troubleshooting
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Features
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Features
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../Features/Command%20palette%20commands/" class="md-nav__link">
<span class="md-ellipsis">
Command palette commands
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../Features/Exclude%20folders/" class="md-nav__link">
<span class="md-ellipsis">
Exclude folders
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../Features/File%20context%20menu%20commands/" class="md-nav__link">
<span class="md-ellipsis">
File context menu commands
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../Features/Folder%20context%20menu%20commands/" class="md-nav__link">
<span class="md-ellipsis">
Folder context menu commands
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5_5" >
<label class="md-nav__link" for="__nav_5_5" id="__nav_5_5_label" tabindex="0">
<span class="md-ellipsis">
Settings
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_5">
<span class="md-nav__icon md-icon"></span>
Settings
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../Features/Settings/File%20explorer/" class="md-nav__link">
<span class="md-ellipsis">
File explorer settings
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../Features/Settings/General/" class="md-nav__link">
<span class="md-ellipsis">
General settings
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../Features/Settings/Path/" class="md-nav__link">
<span class="md-ellipsis">
Path settings
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#how-to-install-the-plugin" class="md-nav__link">
<span class="md-ellipsis">
How to install the plugin
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#basic-features" class="md-nav__link">
<span class="md-ellipsis">
Basic features
</span>
</a>
<nav class="md-nav" aria-label="Basic features">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#create-folder-note" class="md-nav__link">
<span class="md-ellipsis">
Create folder note
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#open-folder-note" class="md-nav__link">
<span class="md-ellipsis">
Open folder note
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create-folder-overview" class="md-nav__link">
<span class="md-ellipsis">
Create folder overview
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<div><h1 id="getting-started">Getting started</h1>
<h2 id="how-to-install-the-plugin">How to install the plugin</h2>
<p>The plugin can be downloaded by clicking on <a href="https://obsidian.md/plugins?id=folder-notes">https://obsidian.md/plugins?id=folder-notes</a> and then on install.</p>
<h2 id="basic-features">Basic features</h2>
<h3 id="create-folder-note">Create folder note</h3>
<p>There are three options: the context menu, ctrl/strg + click and commands</p>
<p>Right click or on mobile hold longer on a folder name to get to the context menu and then click on create folder note.</p>
<p><img alt="Context menu" src="../assets/TOtiFIYzUI8rwxjCLhyN.png"></p>
<p>On PC either use ctrl or strg (depending on your settings) and then click on a folder name to create a folder note.</p>
<p>Open the <a href="https://help.obsidian.md/Plugins/Command+palette">command palette</a> and then type "folder notes" and select the command you need.</p>
<p><img alt="Command palette" src="../assets/screenshots/Obsidian_3VEQ3kOT4S.png"></p>
<h3 id="open-folder-note">Open folder note</h3>
<p>If you haven't changed any settings the simplest option is just to click on the name of a folder to open its folder note.</p>
<p>Use the context menu and instead of create click of open folder note. It only works with folders that also have a folder note and <a href="#Create%20folder%20note">if you don't know how to open the context menu click here.</a></p>
<p><img alt="Context menu" src="../assets/XjlSBfx6ouPrRpb2JmcL.png"></p>
<p>The second option is to open one file of the files from the folder from which you want to open the folder note and then use the command "Open folder note of current folder of active note" from the <a href="https://help.obsidian.md/Plugins/Command+palette">command palette</a></p>
<p>The last option and the option that is only available to desktop users is to use alt or ctrl and click on the folder name. When you don't hold ctrl/alt and click on a folder name the folder gets collapsed as normal. To use this option you first have to enable it in the plugin settings under the tab general.</p>
<p><img alt="Settings page" src="../assets/screenshots/Obsidian_7B8zdp5xDh.png"></p>
<h3 id="create-folder-overview">Create folder overview</h3>
<p>Find more out about the folder overview feature on the <a href="../Folder%20overview/">folder overview page</a></p>
<p>To create a folder overview in a note either use the command "Insert folder overview" or on pc right click and select "create folder overview"</p>
<p><img alt="Context menu" src="../assets/VyBTGhA5eJAVVFusZXIz.png" style="max-width: 40%;max-height: 40%"></p>
<p>The folder overview with the default settings looks like this with one note</p>
<p><img alt="Folder overview" src="../assets/u6ccTTzVbwzBivySFacZ.png">
To find out how to edit the folder overview have a look at <a href="../Folder%20overview/">folder overview page</a></p></div>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.expand"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../assets/javascripts/bundle.79ae519e.min.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink