isocpp / isocpp/CppCoreGuidelines

C++ Core Guidelines Markdown explicit anchor links not working (updated the 20/05/2024)

Open
#2,198 3 comments 0 reactions 1 assignee View on GitHub

@cubbimew is already working on this.

Since Jun 6, 2024.

Dominant language
CSS
Stars
45.3k
Forks
5.6k
PR merge metrics
No merged PRs in 30d

Description

Thanks again for your document C++ Core Guidelines.

Markdown links for C++ Core Guidelines Markdown don't work because anchor test must always be lowercase and not contain spaces, as describe in this article.

I used Sublime Text to find and replace by regular expression with these values, it looks correct but I haven't checked everything (updated the 20/05/2024):
Find: name="([^"]*)"
Replace: name="\L\1\E"
and
Find: ]\(#([^)]*)\)
Replace: ](#\L\1\E)

Attached the .diff, the modified and the old Markdown files :
CppCoreGuidelines - old.md
CppCoreGuidelines.diff.txt
CppCoreGuidelines.md

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.