eslint-plugin-markdown-preferences

Appearance

markdown-preferences/definitions-last ​

require link definitions and footnote definitions to be placed at the end of the document

  • 🔧 The --fix option on the command line can automatically fix some of the problems reported by this rule.

📖 Rule Details ​

This rule requires link definitions ([label]: URL) and footnote definitions ([^label]: text) to be placed at the end of the document, after all other content.

md
<!-- eslint markdown-preferences/definitions-last: 'error' -->

<!-- ✓ GOOD -->

# Example Document

## Section 1: Introduction

Welcome to our documentation. For more details, see [Project Overview].
You can also refer to [Project Overview] again in this section for emphasis.

Additionally, check out [User Guide] for another resource.

## Section 2: Resources

In this section, we mention [User Guide] as a useful link.

## Section 3: Notes (Single Section Footnote)

Here is a footnote for further explanation.[^about-section]
You can also refer to the same footnote again in this section.[^about-section]

## Section 4: Additional Notes (Multiple Sections Footnote)

This section references a footnote used in multiple sections.[^shared-note]

## Section 5: More Notes

This section also references the same footnote for completeness.[^shared-note]

[Project Overview]: https://example.com/project-overview
[User Guide]: https://example.com/user-guide

[^about-section]: This is a footnote definition referenced only from Section 3.

[^shared-note]: This is a footnote definition referenced from multiple sections (Section 4 and Section 5).
md
<!-- eslint markdown-preferences/definitions-last: 'error' -->

<!-- ✗ BAD -->

# Example Document

## Section 1: Introduction

Welcome to our documentation. For more details, see [Project Overview].
You can also refer to [Project Overview] again in this section for emphasis.

Additionally, check out [User Guide] for another resource.


[Project Overview]: https://example.com/project-overview


## Section 2: Resources

In this section, we mention [User Guide] as a useful link.


[User Guide]: https://example.com/user-guide


## Section 3: Notes (Single Section Footnote)

Here is a footnote for further explanation.[^about-section]
You can also refer to the same footnote again in this section.[^about-section]


[^about-section]: This is a footnote definition referenced only from Section 3.


## Section 4: Additional Notes (Multiple Sections Footnote)

This section references a footnote used in multiple sections.[^shared-note]


[^shared-note]: This is a footnote definition referenced from multiple sections (Section 4 and Section 5).


## Section 5: More Notes

This section also references the same footnote for completeness.[^shared-note]

🔧 Options ​

json
{
  "markdown-preferences/definitions-last": [
    "error",
    {
      "linkDefinitionPlacement": {
        "referencedFromSingleSection": "document-last", // "document-last", or "section-last",
        "referencedFromMultipleSections": "document-last" // "document-last", "first-reference-section-last", or "last-reference-section-last"
      },
      "footnoteDefinitionPlacement": {
        "referencedFromSingleSection": "document-last", // "document-last", or "section-last",
        "referencedFromMultipleSections": "document-last" // "document-last", "first-reference-section-last", or "last-reference-section-last"
      }
    }
  ]
}

This rule provides options to control where link and footnote definitions should be placed, depending on the number of references and the type of definition.

  • linkDefinitionPlacement: Options for link reference definitions ([label]: URL).
    • referencedFromSingleSection: Where to place the definition when it is referenced only from a single section. Default is "document-last".
      • "document-last": At the end of the document.
      • "section-last": At the end of the section where the reference appears.
    • referencedFromMultipleSections: Where to place the definition when it is referenced from two or more sections. Default is "document-last".
      • "document-last": At the end of the document.
      • "first-reference-section-last": At the end of the section where the reference is first used.
      • "last-reference-section-last": At the end of the section where the reference is last used.
  • footnoteDefinitionPlacement: Options for footnote definitions ([^label]: text).
    • referencedFromSingleSection: Where to place the definition when it is referenced only from a single section. Default is "document-last".
      • "document-last": At the end of the document.
      • "section-last": At the end of the section where the reference appears.
    • referencedFromMultipleSections: Where to place the definition when it is referenced from two or more sections. Default is "document-last".
      • "document-last": At the end of the document.
      • "first-reference-section-last": At the end of the section where the reference is first used.
      • "last-reference-section-last": At the end of the section where the reference is last used.

Example With Options ​

The following options place link definitions at the last of the section where the reference appears. However, if there are multiple references, the definition is placed at the last of the document. Footnote definitions are always placed at the last of the document.

This is based on the Google Markdown Style Guide.

json
{
  "markdown-preferences/definitions-last": [
    "error",
    {
      "linkDefinitionPlacement": {
        "referencedFromSingleSection": "section-last",
        "referencedFromMultipleSections": "document-last"
      },
      "footnoteDefinitionPlacement": {
        "referencedFromSingleSection": "document-last",
        "referencedFromMultipleSections": "document-last"
      }
    }
  ]
}
md
<!-- eslint markdown-preferences/definitions-last: [
    "error",
    {
      "linkDefinitionPlacement": {
        "referencedFromSingleSection": "section-last",
        "referencedFromMultipleSections": "document-last"
      },
      "footnoteDefinitionPlacement": {
        "referencedFromSingleSection": "document-last",
        "referencedFromMultipleSections": "document-last"
      }
    }
  ] -->

<!-- ✓ GOOD -->

# Example Document

## Section 1: Introduction

Welcome to our documentation. For more details, see [Project Overview].
You can also refer to [Project Overview] again in this section for emphasis.

Additionally, check out [User Guide] for another resource.

[Project Overview]: https://example.com/project-overview

## Section 2: Resources

In this section, we mention [User Guide] as a useful link.

## Section 3: Notes (Single Section Footnote)

Here is a footnote for further explanation.[^about-section]
You can also refer to the same footnote again in this section.[^about-section]

## Section 4: Additional Notes (Multiple Sections Footnote)

This section references a footnote used in multiple sections.[^shared-note]

## Section 5: More Notes

This section also references the same footnote for completeness.[^shared-note]

[User Guide]: https://example.com/user-guide

[^about-section]: This is a footnote definition referenced only from Section 3.

[^shared-note]: This is a footnote definition referenced from multiple sections (Section 4 and Section 5).
md
<!-- eslint markdown-preferences/definitions-last: [
    "error",
    {
      "linkDefinitionPlacement": {
        "referencedFromSingleSection": "section-last",
        "referencedFromMultipleSections": "document-last"
      },
      "footnoteDefinitionPlacement": {
        "referencedFromSingleSection": "document-last",
        "referencedFromMultipleSections": "document-last"
      }
    }
  ] -->

<!-- ✗ BAD -->

# Example Document

## Section 1: Introduction

Welcome to our documentation. For more details, see [Project Overview].
You can also refer to [Project Overview] again in this section for emphasis.

Additionally, check out [User Guide] for another resource.

## Section 2: Resources

In this section, we mention [User Guide] as a useful link.


[User Guide]: https://example.com/user-guide


## Section 3: Notes (Single Section Footnote)

Here is a footnote for further explanation.[^about-section]
You can also refer to the same footnote again in this section.[^about-section]


[^about-section]: This is a footnote definition referenced only from Section 3.


## Section 4: Additional Notes (Multiple Sections Footnote)

This section references a footnote used in multiple sections.[^shared-note]


[^shared-note]: This is a footnote definition referenced from multiple sections (Section 4 and Section 5).


## Section 5: More Notes

This section also references the same footnote for completeness.[^shared-note]


[Project Overview]: https://example.com/project-overview

📚 Further Reading ​

🚀 Version ​

This rule was introduced in eslint-plugin-markdown-preferences v0.7.0

🔍 Implementation ​