GithubHelp home page GithubHelp logo

Comments (8)

DavidAnson avatar DavidAnson commented on July 19, 2024

The specification is clear about the need for spaces after list markers: http://spec.commonmark.org/0.27/#list-items

So the output you're getting is technically correct. That said, I agree it's not the most helpful for this scenario. I'll think about how to modify the rule to make things more clear. Thank you!

from markdownlint.

thomasjbradley avatar thomasjbradley commented on July 19, 2024

Thanks for your response.

I just read the spec—and yes it does definitely require as space as you say.
And yeah, you’re right that the error message is “technically” correct—but not terribly helpful.

Though it’s explained to my students that a space is required after a list marker only about half actually add it. It’d be great to come up with a helpful solution.

Just some thoughts here:

  • What’s the benefit of allowing paragraphs to start a line with a dash when the dash is specifically defined as the only list marker? I can’t think of any reason when I would start a paragraph with a dash in Markdown and not expect it to become a list.
  • Maybe I should add a custom post linter to my own code that somehow enforces spaces after dashes.

Thanks for your help.

from markdownlint.

DavidAnson avatar DavidAnson commented on July 19, 2024

I think I can do something useful here. :) Let me finish working on a different issue then I will look into this some more.

from markdownlint.

thomasjbradley avatar thomasjbradley commented on July 19, 2024

Awesome, thanks.

from markdownlint.

DavidAnson avatar DavidAnson commented on July 19, 2024

When people make this mistake, do they tend to forget just some of the spaces or all of them?

from markdownlint.

thomasjbradley avatar thomasjbradley commented on July 19, 2024

It’s almost always all of the spaces.

from markdownlint.

DavidAnson avatar DavidAnson commented on July 19, 2024

This seems like it will be more of a heuristic than an absolute - I'm going to make it a new rule so it can be disabled independently of MD030. I have an implementation in mind, but it may not make the cut for the upcoming release.

from markdownlint.

thomasjbradley avatar thomasjbradley commented on July 19, 2024

Okay—thanks so much for looking into it.

from markdownlint.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.