Skip to content

Commit

Permalink
Merge pull request #956 from pjkaufman/master
Browse files Browse the repository at this point in the history
Update Docs and Versions for Realse
  • Loading branch information
pjkaufman authored Dec 4, 2023
2 parents 796c37d + 52a13b7 commit 7a38e20
Show file tree
Hide file tree
Showing 5 changed files with 78 additions and 2 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Each rule is its own set of logic and is designed to be run independently. This

### YAML rules

- [add-blank-line-after-yaml](https://platers.github.io/obsidian-linter/settings/yaml-rules/#add-blank-line-after-yaml)
- [escape-yaml-special-characters](https://platers.github.io/obsidian-linter/settings/yaml-rules/#escape-yaml-special-characters)
- [force-yaml-escape](https://platers.github.io/obsidian-linter/settings/yaml-rules/#force-yaml-escape)
- [format-tags-in-yaml](https://platers.github.io/obsidian-linter/settings/yaml-rules/#format-tags-in-yaml)
Expand Down
74 changes: 74 additions & 0 deletions docs/docs/settings/yaml-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,80 @@ These rules try their best to work with YAML values in [Obsidian.md](https://obs
- Blank lines may be removed if you try sorting or making modifications to the order of keys in the YAML via the Linter


## Add Blank Line After YAML

Alias: `add-blank-line-after-yaml`

Adds a blank line after the YAML block if it does not end the current file or it is not already followed by at least 1 blank line





### Examples

<details><summary>A file with just YAML in it does not get a blank line after the YAML</summary>

Before:

`````` markdown
---
key: value
---
``````

After:

`````` markdown
---
key: value
---
``````
</details>
<details><summary>A file with YAML followed directly by content has an empty line added</summary>

Before:

`````` markdown
---
key: value
---
Here is some text
``````

After:

`````` markdown
---
key: value
---

Here is some text
``````
</details>
<details><summary>A file with YAML that already has a blank line after it and before content has no empty line added</summary>

Before:

`````` markdown
---
key: value
---

Here is some text
``````

After:

`````` markdown
---
key: value
---

Here is some text
``````
</details>

## Escape YAML Special Characters

Alias: `escape-yaml-special-characters`
Expand Down
2 changes: 1 addition & 1 deletion manifest.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"id": "obsidian-linter",
"name": "Linter",
"version": "1.20.1",
"version": "1.21.0",
"minAppVersion": "1.4.16",
"description": "Formats and styles your notes. It can be used to format YAML tags, aliases, arrays, and metadata; footnotes; headings; spacing; math blocks; regular markdown contents like list, italics, and bold styles; and more with the use of custom rule options as well.",
"author": "Victor Tao",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "obsidian-linter",
"version": "1.20.1",
"version": "1.21.0",
"description": "Enforces consistent markdown styling for Obsidian (https://obsidian.md). It can be used to format YAML tags, aliases, arrays, and metadata; footnotes; headings; spacing; math blocks; regular markdown contents like list, italics, and bold styles; and more with the use of custom rule options as well.",
"main": "main.js",
"scripts": {
Expand Down
1 change: 1 addition & 0 deletions versions.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"1.21.0": "1.4.16",
"1.20.1": "1.4.16",
"1.20.0": "0.15.6",
"1.19.1": "0.15.6",
Expand Down

0 comments on commit 7a38e20

Please sign in to comment.