search

hukkin / mdformat-gfm

Mdformat plugin for GitHub Flavored Markdown compatibility
MIT License
13 stars 2 forks source link

Breaking GitHub templates #12

Closed Borda closed 3 years ago

Borda commented 3 years ago

Describe the problem

I have deployed which changed my Github issue head from

---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug / fix, help wanted
assignees: ''

---

to

______________________________________________________________________

name: Bug report
about: Create a report to help us improve
title: ''
labels: bug / fix, help wanted
assignees: ''

______________________________________________________________________

which is no longer recognised by Github as Issue template

Steps to reproduce

run pre-commit according to docs:

  - repo: https://github.com/executablebooks/mdformat
    rev: 0.7.7
    hooks:
      - id: mdformat
        additional_dependencies:
          - mdformat-gfm
          - mdformat-black

Additional context

https://github.com/executablebooks/mdformat/issues/246#issuecomment-890525454

hukkin commented 3 years ago

Hey there, thanks for the issue!

mdformat-gfm bring GFM compatibilty to mdformat. The frontmatter syntax is not part of GFM specification however. You will need to install a plugin that brings frontmatter support https://pypi.org/project/mdformat_frontmatter/