diff --git a/README.md b/README.md index 55b31c3..47c8604 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,74 @@ -# Current Folder Notes Pane +# πŸ“‚ Current Folder Notes Pane -I use this to show a list of chapters + about files for my novel writing since my writing projects are usually contained in one folder. It sorts the list of chapter e.g. 'Chapter T1 - Hello World', 'Chapter T2 - Running'... +Welcome to **Current Folder Notes Pane**β€”an Obsidian plugin designed to transform how you organize and navigate your writing projects! This plugin is perfect for writers who keep their chapters and related files within a single folder. -You can filter out some notes such as 'index' that you don't want to see in the listing, and only include in a list of notes that have 'chapter' or 'about' in them. +## ✨ What Is It? + +Imagine having a specialized sidebar that shows just the notes you care about from your current folder, intelligently sorted by chapter numbers. Current Folder Notes does exactly that by providing a clean, focused view of your writing project. -How this works ![Annotated_Example](./images/Annotated_Example.png) +## 🌟 Key Features -Example Settings +- πŸ“‹ **Smart Note Listing**: Automatically lists and sorts notes in your current folder (perfect for chapter organization like "Chapter T1 - Hello World", "Chapter T2 - Running"...) +- πŸ” **Powerful Filtering**: Include only the notes that matter (like chapters or about files) and exclude others (like index files) +- ✏️ **Pretty Title Case**: Option to automatically format your note titles in Title Case for better readability +- πŸ“š **Outline Integration**: View headings from your current file or all files right in the pane +- πŸ“ **Subfolder Support**: Optionally include notes from subfolders +- ⭐ **Visual Indicators**: Current file is highlighted with a star for quick identification + +## πŸš€ How to Use + +1. **Open the Pane**: Click the folder icon in the ribbon or use the command "Open Pane" +2. **Navigate Your Project**: Click on any file in the list to open it +3. **Jump to Headings**: Click on any heading in the outline to jump directly to that section + +Perfect for: +- πŸ“ Novel writing with multiple chapters +- πŸŽ“ Research projects with related notes +- πŸ“Š Any project where you need to see a focused list of related files + +## βš™οΈ Settings + +Customize Current Folder Notes to perfectly match your workflow: + +- **Exclude Titles Filter**: Hide specific notes (e.g., "_index" files) +- **Include Titles Filter**: Only show notes containing specific words (e.g., "chapter", "about") +- **Pretty Title Case**: Toggle automatic title formatting for better readability +- **Include Subfolder Notes**: Choose whether to include notes from subfolders +- **Current File Outline**: Show headings from your active file +- **All Files Outline**: Show headings from all files in the folder + +## πŸ“‹ Example Settings + +Perfect for writers organizing a novel project: ![Settings](./images/WritingSettings.png) +## πŸ’» Installation -## Manually installing the plugin +### Community Plugins (Coming Soon) +1. Open Settings > Community plugins +2. Click "Browse" +3. Search for "Current Folder Notes" +4. Click "Install" +5. Once installed, enable the plugin -- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`. +### Manual Installation + +- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/current-folder-notes/` +- Restart Obsidian +- Enable the plugin in Settings > Community plugins + +## πŸ’‘ Tips for Writers + +- Use a consistent naming convention for your chapters (e.g., "Chapter T1 - Introduction") +- Create an "about-characters" or "about-settings" file to keep track of your world-building +- Use headings within your chapters for easy navigation via the outline feature + +## ❓ Questions or Feedback? + +Love the plugin? Found a bug? Have a feature request? Feel free to reach out! + +Enjoy organizing your writing projects with Current Folder Notes Pane! diff --git a/current-folder-notes/manifest.json b/current-folder-notes/manifest.json index 0b3e3a4..75fe449 100644 --- a/current-folder-notes/manifest.json +++ b/current-folder-notes/manifest.json @@ -1,7 +1,7 @@ { "id": "current-folder-notes-pamphlet", "name": "Current Folder Notes", - "version": "1.7.5", + "version": "1.7.7", "minAppVersion": "1.7.7", "description": "Shows a list of notes in the current folder, and allows you to filter the titles to include or exclude notes.", "author": "Pamela Wang", diff --git a/prepareForGitRelease.sh b/prepareForGitRelease.sh index 8b5f292..e8cf5a8 100644 --- a/prepareForGitRelease.sh +++ b/prepareForGitRelease.sh @@ -18,6 +18,9 @@ mv current-folder-notes.zip release.zip # remove the current_release folder # rm -rf current-folder-notes -gac "Push for Release" +# gac "Push for Release" +git add -A +git commit -m "Prepare for Git Release" +git push origin main echo "Use the gh release create command to create a new release" echo "gh release create v(XXX) release.zip --notes-file current-folder-notes/notes.md" \ No newline at end of file