Skip to content

produce valid markdown #4

Description

@snoblenet

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

Activity

  1. rhysd commented on Jul 8, 2019

    @rhysd
    Owner

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

  2. snoblenet commented on Jul 8, 2019

    @snoblenet
    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.)

  3. rhysd commented on Jul 10, 2019

    @rhysd
    Owner

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

  4. rhysd commented on Jul 10, 2019

    @rhysd
    Owner

    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.

  5. rhysd commented on Jul 10, 2019

    @rhysd
    Owner

    Does this actually break some markdown parser?

  6. snoblenet commented on Jul 11, 2019

    @snoblenet
    Author
  7. snoblenet commented on Jul 11, 2019

    @snoblenet
    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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions