Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix some typos README.md #104

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ Obsidian Plugin: Add description note to a folder. Generate card-style overview
- **Add** description note: CTRL+Click on a folder in the file explorer panel.
- **Show** description note: Just Click the folder.
- **Delete** description note: Just delete the opened note file.
- **Settings** : configure the note file method, file name and inital template on the settings panel.
- **Settings** : configure the note file method, file name and initial template on the settings panel.
- **Command**: Use some commands to control the folder note plugin.

## Features

- Dispaly and manage folder note easily
- Display and manage folder note easily
- Support 3 different folder note methods
- Automatically keep folder and folder-note name in syncing
- Make a folder by active note file
Expand All @@ -36,7 +36,7 @@ When CTRL+Click a folder, the plugin will create a description note with the pat
- {{FOLDER_NAME}} will be replaced with the folder name.
- {{FOLDER_PATH}} will be replaced with the folder path.
- {{FOLDER_BRIEF}} will be replaced with a ccard code block for card-style overview of current folder, and the content in the ccard can be edited, see [ccard Syntax](https://github.com/xpgo/obsidian-folder-note-plugin/blob/main/doc/ccard-syntax.md) for more information.
- {{FOLDER_BRIEF_LIVE}} will be replaced with a tiny code block which will be rendered to the folder overview in real time.
- {{FOLDER_BRIEF_LIVE}} will be replaced with a tiny code block which will be rendered to the folder overview in real-time.
- **Key for New Note**: set to use CTRL+Click or ALT+Click for creating new folder note.
- **Hide Folder Note**: turn off the setting if you want to show the note file in file explorer.
- **Auto Rename**: For the methods *Inside-Folder* and *Outside-Folder*, the plugin tries to rename the folder note name when a folder name is changed or vice versa. However, this function is experimental, it does not always work. Rename them manually if you have some issue related to the operation.
Expand All @@ -53,19 +53,19 @@ Use `Ctrl+P` to open Obsidian's command panel, and use the following commands of

The plugin can automatically generate a code block of `ccard` in a note file for displaying overview of a folder. The code block can be used and edited in any normal note file. For the syntax of `ccard` code block, please refer to [ccard Syntax](https://github.com/xpgo/obsidian-folder-note-plugin/blob/main/doc/ccard-syntax.md).

You can use the `ccard` code block in the inital folder note template in the settings page. Alternatively, you can use some keywords in the initial folder note template to generate the code blocks for you:
You can use the `ccard` code block in the initial folder note template in the settings page. Alternatively, you can use some keywords in the initial folder note template to generate the code blocks for you:

**Keyword: {{FOLDER_BRIEF}}**

The keyword {{FOLDER_BRIEF}} will be replaces with a `ccard` code block which describes an brief overview of the folder. You can edit the codes in the code block to display whatever content you like. If you want to update the overview of a folder, it can be inserted to a note by command: Ctrl+P, Insert Folder Overview.
The keyword {{FOLDER_BRIEF}} will be replaced with a `ccard` code block which describes a brief overview of the folder. You can edit the codes in the code block to display whatever content you like. If you want to update the overview of a folder, it can be inserted to a note by command: Ctrl+P, Insert Folder Overview.

**Keyword: {{FOLDER_BRIEF_LIVE}}**

The keyword {{FOLDER_BRIEF_LIVE}} will be replaced with a `ccard` code block which will be rendered to the folder overview in real time. It is useful when you put some notes with image in a folder, e.g., things collections, it will generate a card view of all the notes with images dynamically.
The keyword {{FOLDER_BRIEF_LIVE}} will be replaced with a `ccard` code block which will be rendered to the folder overview in real-time. It is useful when you put some notes with images in a folder, e.g., things collections, it will generate a card view of all the notes with images dynamically.

**Configuration**

If you want to configure the content and appearence of the `ccard` code block, please refer to [ccard Syntax](https://github.com/xpgo/obsidian-folder-note-plugin/blob/main/doc/ccard-syntax.md). You can configure the style, colume number, image prefix, folder path, note only, max brief length and more. For example, the following image show different styles of folder overview.
If you want to configure the content and appearance of the `ccard` code block, please refer to [ccard Syntax](https://github.com/xpgo/obsidian-folder-note-plugin/blob/main/doc/ccard-syntax.md). You can configure the style, column number, image prefix, folder path, note only, max brief length and more. For example, the following image shows different styles of folder overview.

![Card_Strip_Style](https://raw.githubusercontent.com/xpgo/obsidian-folder-note-plugin/master/image/style-card-strip.png)

Expand All @@ -79,8 +79,8 @@ Remember to update the plugin, if you find some issues.
### 0.7.x

- add strip style view of item data (0.7.3)
- use {{FOLDER_BRIEF_LIVE}} for default inital content (0.7.2)
- add Keyword {{FOLDER_PATH}} for inital content (0.7.1)
- use {{FOLDER_BRIEF_LIVE}} for default initial content (0.7.2)
- add Keyword {{FOLDER_PATH}} for initial content (0.7.1)
- fix multiple usage of some keywords for initial content (0.7.1)
- add imagePrefix key for ccard (0.7.0)
- add noteOnly Key for folder_brief_live (0.7.0)
Expand All @@ -91,7 +91,7 @@ See [more change log](https://github.com/xpgo/obsidian-folder-note-plugin/blob/m

## Plans for future

- Add more template option for generating the initial content.
- Add more template options for generating the initial content.
- Automatically generate overview contents for the folder note file based on contents in the folder, like the software [Trilium](https://github.com/zadam/trilium) does. (Partially done.)
- More robust renaming operation.
- More style of overview.
Expand Down
8 changes: 4 additions & 4 deletions doc/change-log.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

## 0.7.x

- use {{FOLDER_BRIEF_LIVE}} for default inital content (0.7.2)
- add Keyword {{FOLDER_PATH}} for inital content (0.7.1)
- use {{FOLDER_BRIEF_LIVE}} for default initial content (0.7.2)
- add Keyword {{FOLDER_PATH}} for initial content (0.7.1)
- fix multiple usage of some keywords for initial content (0.7.1)
- add imagePrefix key for ccard (0.7.0)
- add noteOnly Key for folder_brief_live (0.7.0)
Expand Down Expand Up @@ -39,7 +39,7 @@

## 0.3.x

- add keyword {{FOLDER_BRIEF_LIVE}} for inital content to generate folder overview in real time. (0.3.3)
- add keyword {{FOLDER_BRIEF_LIVE}} for initial content to generate folder overview in real-time. (0.3.3)
- Insert folder overview by command: ctrl+p, Insert Folder Overview (0.3.2)
- Reorganized source code and fixed a mini bug (0.3.2)
- Fix the command key on Mac (0.3.1)
Expand All @@ -59,4 +59,4 @@

- Add description note for a folder: CTRL+Click on a folder node in the file explorer panel.
- Show description note of a folder: Just Click the folder.
- Delete description note of a folder: Just delete the opened note file.
- Delete description note of a folder: Just delete the opened note file.
4 changes: 2 additions & 2 deletions src/settings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ export class FolderNoteSettingTab extends PluginSettingTab {
}

new Setting(containerEl)
.setName('Inital Content')
.setDesc('Set the inital content for new folder note. {{FOLDER_NAME}} will be replaced with current folder name.')
.setName('Initial Content')
.setDesc('Set the initial content for new folder note. {{FOLDER_NAME}} will be replaced with current folder name.')
.addTextArea(text => {
text
.setPlaceholder('About the folder.')
Expand Down