Skip to content

Differences to prettier style #110

@hukkin

Description

@hukkin

This issue documents the main differences noted in mdformat style and prettier style when formatting Markdown in https://github.com/lambda-fairy/maud

  1. Mdformat moves link reference definitions to the bottom of the doc
  2. Mdformat orders link reference definitions
  3. Mdformat applies non-numbering to lists (by default)
  4. Mdformat converts indented code blocks to fenced code blocks
  5. Mdformat converts shortcut reference links into full reference links, e.g. [ref link] into [ref link][ref link] EDIT: This is fixed in version 0.5.5
  6. Mdformat escapes square brackets. Prettier preserves escapes from source text.

To me everything else seems desirable, besides the last two differences (5. and 6.). I will turn those into separate issues.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions