GithubHelp home page GithubHelp logo

Comments (7)

DavidAnson avatar DavidAnson commented on July 19, 2024

That scenario is correct and documented: https://github.com/DavidAnson/markdownlint/blob/main/doc/md025.md

from markdownlint.

garysassano avatar garysassano commented on July 19, 2024

I see. Yet I don't understand what's the rationale behind this choice, and what's the recommended change when you want to have the h1 header and the page title to be the same.

from markdownlint.

DavidAnson avatar DavidAnson commented on July 19, 2024

Some systems (Jekyll, perhaps?) automatically use the front matter title as the H1 for the rendered page. In that scenario, what you show here would result in a duplicate title at the top of the blog. If that's not relevant for your situation, it's probably best to disable this rule at a project level.

from markdownlint.

garysassano avatar garysassano commented on July 19, 2024

How can you disable it at the project level? I'm using Astro btw.

from markdownlint.

DavidAnson avatar DavidAnson commented on July 19, 2024

I don't know anything about how Astro works, but the typical way to do this would be to put a .markdownlint.json file in the root of the project. It only needs to disable the relevant rule by giving it the value false, but here is a complete example of what that file could contain: https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.jsonc

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.