Skip to content

Commit 90c580d

Browse files
committed
update bad links readme
1 parent 3b613ab commit 90c580d

File tree

1 file changed

+65
-1
lines changed

1 file changed

+65
-1
lines changed

Snippets/Bad Links 1/README.md

+65-1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
- [CSS](#css)
1919
- [Customization](#customization)
2020
- [Page Titles / Frontmatter Support](#page-titles--frontmatter-support)
21+
- [Change Appearance / CSS](#change-appearance--css)
2122

2223
<br />
2324

@@ -1012,4 +1013,67 @@ The section below explains how to customize this snippet.
10121013
<br />
10131014
10141015
### Page Titles / Frontmatter Support
1015-
This script supports `Frontmatter` / `Metadata` titles.
1016+
This script supports `Frontmatter` / `Metadata` titles. When one of your notes includes a broken link, the name of the note will display in the Bad Links snippet. The name of each page displayed has several ways of being defined, and supports **frontmatter**.
1017+
1018+
<br />
1019+
1020+
The name that displays for each page will have the following priority:
1021+
1. `frontmatter.name`
1022+
2. `frontmatter.title`
1023+
3. `frontmatter.alias`
1024+
4. `filename.Name`
1025+
1026+
<br />
1027+
1028+
If none of the above frontmatter values are specified, the normal file name of the page will be used.
1029+
1030+
<br />
1031+
1032+
Based on the priority list above, if you provide both a frontmatter `name` AND `title`, the frontmatter **name** will be used first.
1033+
1034+
<br />
1035+
1036+
If you provide a frontmatter `title` and frontmatter `alias`, then the frontmatter **title** will be used.
1037+
1038+
<br />
1039+
1040+
To define frontmatter values, add the following to the very top of your page:
1041+
1042+
```markdown
1043+
---
1044+
title: "Your Page Title"
1045+
---
1046+
```
1047+
1048+
<br />
1049+
1050+
You cannot have any blank lines above the first `---`.
1051+
1052+
<br />
1053+
1054+
If you do not specify `title`, `name`, or `alias` in your frontmatter, the normal page filename will be used.
1055+
1056+
<br />
1057+
<br />
1058+
1059+
### Change Appearance / CSS
1060+
This snippet supports tweaking the look and feel of the cloud & tags using the **[Style Settings](https://github.com/mgmeyers/obsidian-style-settings)** plugin. If you want to change how this snippet looks:
1061+
- Open `Obsidian Settings`
1062+
- Install the `Style Settings` plugin
1063+
- Select `Style Settings` config panel under `Community Plugins`.
1064+
- Click the tab `Bad Links - Version 1`
1065+
- Edit the settings for the Page Cloud tags
1066+
1067+
<br />
1068+
1069+
<p align="center"><img style="width: 70%;text-align: center;" src="https://raw.githubusercontent.com/Aetherinox/obsidian-dataview-snippets/main/Snippets/Bad%20Links%201/images/example_5.gif"></p>
1070+
1071+
<br /><br />
1072+
1073+
<div align="center">
1074+
1075+
**[`^ back to top ^`](#table-of-contents-)**
1076+
1077+
</div>
1078+
1079+
<br /><br />

0 commit comments

Comments
 (0)