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

produce valid markdown #4

Open
snoblenet opened this issue Jul 7, 2019 · 7 comments
Open

produce valid markdown #4

snoblenet opened this issue Jul 7, 2019 · 7 comments

Comments

@snoblenet
Copy link

Great tool. Can there be a blank line after the first heading please so the markdown is valid?

@rhysd
Copy link
Owner

rhysd commented Jul 8, 2019

Could you describe exact steps to reproduce this (your environment, setup, command executed, expected output)

@snoblenet
Copy link
Author

Hi there.

At the cli type notes new foo bar batz.

Expected result:

bar
===

- Category: foo
- Tags: batz
- Created: 2019-07-09T09:04:12+10:00

(Valid Markdown, with blank line after H1.)

Actual result:

bar
===
- Category: foo
- Tags: batz
- Created: 2019-07-09T09:04:12+10:00

(Invalid Markdown, with no blank line after H1.)

@rhysd
Copy link
Owner

rhysd commented Jul 10, 2019

Thank you for the description. I'll look into this.

@rhysd
Copy link
Owner

rhysd commented Jul 10, 2019

It seems that your 'Actual result' is not an invalid markdown.

From commonmark spec

In general, a setext heading need not be preceded or followed by a blank line. However, it cannot interrupt a paragraph, so when a setext heading comes after a paragraph, a blank line is needed between them.

So, === line just before list should be ok.

@rhysd
Copy link
Owner

rhysd commented Jul 10, 2019

Does this actually break some markdown parser?

@snoblenet
Copy link
Author

@snoblenet
Copy link
Author

for now I've added a local .markdownlint.json to the notes-cli directly disabling 022 and 032

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

No branches or pull requests

2 participants