Allow for a Footnotes section at the end of an Awesome list

sindresorhus / awesome-lint

Linter for Awesome lists

MIT License

609 stars 59 forks source link

Allow for a Footnotes section at the end of an Awesome list #118

Closed kdeldycke closed 4 years ago

kdeldycke commented 4 years ago

That way we can group non-important but necessary content (like extra-copyright notices, hyperlinks to sources, pointers to expansive content, ...) at the end of the document while keeping the main content hyper-focused to our curated awesome lists.

Fixes #117 .

Real-life example available on the Awesome Falsehood project at: https://github.com/kdeldycke/awesome-falsehood/blob/d8db15ad0c6b0acaea1e6da1f48ea4a5922d4118/readme.md#footnotes

kdeldycke commented 4 years ago

All tests are passing, this PR is ready to be reviewed and eventually merged! 😃

sindresorhus commented 4 years ago

Maybe we should mention this in https://github.com/sindresorhus/awesome/blob/main/pull_request_template.md

kdeldycke commented 4 years ago

@sindresorhus good idea! Just proposed a PR at https://github.com/sindresorhus/awesome/pull/1860 to include those new rules.