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 typo in example of heading-blank-lines #656

Merged
merged 2 commits into from
Mar 21, 2023

Conversation

northword
Copy link
Contributor

document: https://github.com/platers/obsidian-linter/blob/master/docs/rules.md#heading-blank-lines
related: #219

Example: Empty line before header and after Yaml is removed with Empty Line Between Yaml and Header=true

Before:

---
key: value
---
# Header
Paragraph here...
After:
---
key: value
---
# Header

Paragraph here...

when Empty Line Between Yaml and Header=true, it should be

> ---
> key: value
> ---
>
> # Header
> 
> Paragraph here...

only when Empty Line Between Yaml and Header=false, it is

> ---
> key: value
> ---
> # Header
> 
> Paragraph here...

In addition, a blank line has been added after the YAML in before to better illustrate that the blank line between the YAML and the title will be removed when Empty Line Between Yaml and Header=false.

Copy link
Collaborator

@pjkaufman pjkaufman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the indentation is fixed as requested by the CI, I am fine with approving this.

src/rules/heading-blank-lines.ts Outdated Show resolved Hide resolved
@northword northword requested a review from pjkaufman March 19, 2023 12:05
@northword
Copy link
Contributor Author

Thanks, the question has been revised, please review again.

@pjkaufman pjkaufman merged commit fb5b8e3 into platers:master Mar 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants