[GH-ISSUE #310] Shebang support #2114

New issue

Closed

opened 2026-03-07 20:04:43 +03:00 by kerem · 5 comments

kerem commented

2026-03-07 20:04:43 +03:00

Owner

Originally created by @brandonkal on GitHub (Jul 31, 2020).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/310

The file's shebang line should be stripped before the text is passed to rules.
I found that rules 18 and 41 complain on the line. This should be simple to implement.

Originally created by @brandonkal on GitHub (Jul 31, 2020). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/310 The file's shebang line should be stripped before the text is passed to rules. I found that rules 18 and 41 complain on the line. This should be simple to implement.

kerem

2026-03-07 20:04:43 +03:00

closed this issue
added the
question
label

kerem commented

2026-03-07 20:04:44 +03:00

Author

Owner

@DavidAnson commented on GitHub (Jul 31, 2020):

Can you please show an example? I’m not familiar with shebang in Markdown; the files are not usually executable.

https://en.m.wikipedia.org/wiki/Shebang_(Unix)

@DavidAnson commented on GitHub (Jul 31, 2020): Can you please show an example? I’m not familiar with shebang in Markdown; the files are not usually executable. https://en.m.wikipedia.org/wiki/Shebang_(Unix)

kerem commented

2026-03-07 20:04:44 +03:00

Author

Owner

@brandonkal commented on GitHub (Jul 31, 2020):

The pattern is not widespread but it enables some exciting use-cases.

I support it in my https://github.com/brandonkal/inkjet tool to build rapid CLIs and as a project task runner.
There is also https://github.com/bashup/mdsh to compile markdown to bash scripts.

@brandonkal commented on GitHub (Jul 31, 2020): The pattern is not widespread but it enables some exciting use-cases. - I support it in my https://github.com/brandonkal/inkjet tool to build rapid CLIs and as a project task runner. - There is also https://github.com/bashup/mdsh to compile markdown to bash scripts.

kerem commented

2026-03-07 20:04:44 +03:00

Author

Owner

@DavidAnson commented on GitHub (Jul 31, 2020):

It’s a slight abuse of the feature, but have you tried defining a front matter regular expression to match the shebang syntax? That should tell the tool to strip that first line out automatically.

@DavidAnson commented on GitHub (Jul 31, 2020): It’s a slight abuse of the feature, but have you tried defining a front matter regular expression to match the shebang syntax? That should tell the tool to strip that first line out automatically.

kerem commented

2026-03-07 20:04:44 +03:00

Author

Owner

@DavidAnson commented on GitHub (Sep 19, 2020):

For this use case, I the suggestion above seems to work fine:

pi@pi:~/shebang $ cat shebang.md
#!/usr/bin/env node

# Heading

Markdown text.
pi@pi:~/shebang $ cat .markdownlint-cli2.jsonc
{
  "frontMatter": "^#!.*(\r?\n)"
}
pi@pi:~/shebang $ markdownlint-cli2 shebang.md
Finding: shebang.md
Linting: 1 file(s)
Summary: 0 error(s)
pi@pi:~/shebang $

@DavidAnson commented on GitHub (Sep 19, 2020): For this use case, I the suggestion above seems to work fine: ```bash pi@pi:~/shebang $ cat shebang.md #!/usr/bin/env node # Heading Markdown text. pi@pi:~/shebang $ cat .markdownlint-cli2.jsonc { "frontMatter": "^#!.*(\r?\n)" } pi@pi:~/shebang $ markdownlint-cli2 shebang.md Finding: shebang.md Linting: 1 file(s) Summary: 0 error(s) pi@pi:~/shebang $ ```

kerem commented

2026-03-07 20:04:44 +03:00

Author

Owner

@DavidAnson commented on GitHub (Oct 16, 2020):

Closing issue since this seems to be an uncommon scenario and the approach outlined above works.

@DavidAnson commented on GitHub (Oct 16, 2020): Closing issue since this seems to be an uncommon scenario and the approach outlined above works.