butler54 / mdformat-frontmatter Goto Github PK

I suggest using ruamel.yaml instead of pyyaml to preserve comments in YAML front matter.

Testing behaviour to date is woeful. Improve various test conditions that may occur.

Current process automates deployment on tagging, however, relies on the developer manually updating the version tag. Convert / update build process to allow automated semantic releases.

Would be nice to add the "mdformat" GitHub topic to make the plugin accessible on https://github.com/topics/mdformat

This dependency is highly idiosyncratic. It still uses setup.py and seems to generate one, indeed. It also generates source code within a Dockerfile. It uses custom C source code. The sole maintainer hosts its source code on SourceForge, an outdated platform. He categorizes these packages on PyPI as beta quality.

Can you not use the more popular PyYAML?

Hello I've installed mdformat via AUR package https://aur.archlinux.org/packages/mdformat ,

AUR was way who I discovered mdformat.

maybe it is possible to either make it part of this package or make another AUR package to make it easy to discover for users ? - just idea

cross linkling: executablebooks/mdformat#372 (comment)

We use mdformat to format markdowns. For automation and validation, the markdowns have yaml header with metadata about the document.
We use pre-commit hook to invoke mdformat and mdformat-frontmatter plugin so that the yaml can be ignored.
pre-commit version 2.17.0
mdformat version: 0.7.13

- repo: https://github.com/executablebooks/mdformat
    rev: 0.7.13 # Do not change version. 0.6.0 introduces breaking changes.
    hooks:
    - id: mdformat
      exclude: "CHANGELOG.md|docs/mkdocs_code_of_conduct.md|docs/api_reference"
      additional_dependencies:
      - mdformat-tables
      - mdformat-config
      - mdformat-frontmatter
      - mdformat-gfm

Notice that mdformat-frontmatter is formatting data in the header and inserting new lines.
example changes:

source-location: https://github.com/master/procedures/test-n/test-n.md

to

source-location: 
  https://github.com/master/procedures/test-n/test-n.md

Expected behavior:
The new lines should not be added and yaml header should not be formatted at all.