docs: update the banner & metadata info following the update that all…

…ow links in it
Enveloppe · Jan 24, 2025 · 696ed22 · 696ed22
1 parent 757cdc0
commit 696ed22
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 7 deletions.
diff --git a/docs/Settings/Embed.md b/docs/Settings/Embed.md
@@ -33,13 +33,22 @@ Additionally, you can choose to send files based on a metadata field. This means
 >
 > ```
 > ---
-> banner: my_image.png
+> banner: [[my_image.png]]
 > ---
 > ```
 >
 > If you set the metadata `banner`, the image will be sent to the default attachment folder. All attachments supported by Obsidian (plus Markdown files) are supported.
 > This means that you can send images, pdfs, audio files and any other types of files that are supported by Obsidian and are embedded in your notes.
 
+> [!TIP]
+> Using wikilink in the metadata is a more reliable way to send the file into your repository.
+> If you needs to remove it, you should use a regex, like this:
+>
+> | Regex                                       | Replacement  | After   | in code blocks | Example (Regex101)                                                                      |
+> |---------------------------------------------|--------------|---------|----------------|-----------------------------------------------------------------------------------------|
+> | `/banner: \"[{2}(.*)\/(.*)\|(.*)]{2}\"\|/g` | `banner: $2` | `false` | `false`        | [Keep only the name of the link that is set with path](https://regex101.com/r/FgdOLP/1) |
+> | `/banner: "[](([^\)+)(?:\|[^]]+)?]]"\|/g`   | `banner: $1` | `false` | `false`        | [Same as above, but with a non path, alias optional](https://regex101.com/r/NkaFxE/1)   |
+
 This feature allows you to easily share all the necessary resources in your notes with your remote repository.
 
 ## Embed notes

diff --git a/docs/index.md b/docs/index.md
@@ -22,12 +22,10 @@ Enveloppe is a remarkable project that enables you to effortlessly transmit file
 
 1. Install the plugins through Obsidian Community or [BRAT](https://github.com/TfTHacker/obsidian42-brat)
 2. Configure the plugin options:
-
-- Repo name
-- Your GitHub username
-- The GitHub token (available [here](https://github.com/settings/tokens/new?scopes=repo))
-- The share key
-
+   - Repo name
+   - Your GitHub username
+   - The GitHub token (available [here](https://github.com/settings/tokens/new?scopes=repo))
+   - The share key
 3. Add the sharing key as `true` in Obsidian's note frontmatter
 4. Customize (or not) the folder options
 5. Run the commands through the file menu or commands palette.