Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 3 commits into from Sep 3, 2020
Merged

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

merged 3 commits into from Sep 3, 2020

Conversation

kdeldycke
Copy link
Contributor

@kdeldycke kdeldycke commented Sep 2, 2020

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
Copy link
Contributor Author

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

@sindresorhus sindresorhus changed the title Allow for a Footnotes section at the end of an awesome list Allow for a Footnotes section at the end of an Awesome list Sep 3, 2020
@sindresorhus sindresorhus merged commit 2ce6b16 into sindresorhus:master Sep 3, 2020
@sindresorhus
Copy link
Owner

@kdeldycke
Copy link
Contributor Author

@sindresorhus good idea! Just proposed a PR at sindresorhus/awesome#1860 to include those new rules.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Proposal: allow for a TOC-silent "Footnotes" section at README's bottom.
2 participants