Support explicit heading IDs

[samajammin]

Prize Bounty

1.25 ETH

Challenge Description

We're having the same issue as reactjs/react.dev#1608, which currently creates a bunch of manual effort to search & replace links referencing header anchors for every translation.

As explained here, we should stop auto-generating anchor links from the heading text (e.g. #_2-what-is-eth-and-how-do-i-get-it, #_2-qu-est-ce-que-l-eth-et-comment-puis-je-en-obtenir, #_2-ethとは？どうやって手に入れるの？). Auto-generating does more harm than good because: 1) translating one heading means having to search in the entire docs and change multiple files simultaneously, 2) URL encoded CJK anchor names are ugly and unreadable & 3) anchors are part of URLs and thus should not be translated anyway, just as file names should not be translated.

Update the application to support consistent anchor links across languages.

Possible Solutions

1. Add support for custom ID markdown syntax (like Support Custom-ID Markdown Syntax reactjs/react.dev#1636)
2. Use link anchors in markdown & add styling to keep UI the same

Submission Requirements

• All anchor links of all languages are the English version (e.g. the German link for the "What is ETH, and how do I get it?" section should be https://ethereum.org/de/use/#_2-what-is-eth-and-how-do-i-get-it, not what it is currently: https://ethereum.org/de/use/#_2-was-ist-eth-und-wie-bekomme-ich-es)
• The solution is flexible enough to automatically support future translations & header links

Submission Deadline

The deadline for submissions is November 11, 2019.

Judging Criteria

The prize will be awarded to the first valid submission.

Winner Announcement Date

The submission will be reviewed by November 18. Winner announcements and prize payouts will occur before November 31, 2019.

[samajammin]

Spiked on option 2, doesn't look like a good solution. Looks like we may want to create a Vuepress plugin but not planning to invest time into that right now. Contributions welcome!

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

This issue now has a funding of 1.25 ETH (229.06 USD @ $183.25/ETH) attached to it.

• If you would like to work on this issue you can 'start work' on the Gitcoin Issue Details page.
• Want to chip in? Add your own contribution here.
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $103,885.97 more funded OSS Work available on the Gitcoin Issue Explorer

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

Work has been started.

These users each claimed they can complete the work by 2 years, 3 months ago.
Please review their action plans below:

1) think-in-universe has started work.

I have implemented the markdown syntax for explicit heading IDs, and converted the anchor of all languages into English version.

Learn more on the Gitcoin Issue Details page.

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

Work for 1.25 ETH (228.21 USD @ $182.57/ETH) has been submitted by:

1. @think-in-universe

@vs77bb please take a look at the submitted work:

• PR by @think-in-universe

---

• Learn more on the Gitcoin Issue Details page
• Want to chip in? Add your own contribution here.
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $123,574.37 more funded OSS Work available on the Gitcoin Issue Explorer

[think-in-universe]

@samajammin please help review the design and implementation, one netlify preview version is available here, https://deploy-preview-369--ethereumorg.netlify.com/ after submitting the PR #369.

I think the translation tasks (#357, #358) could benefit from this feature.

[think-in-universe]

@samajammin I agree the option 2 is not as easy the heading anchor syntax in reactjs/react.dev#1636. I'll extract the code we implemented in this feature, and create a markdown-it plugin, so more projects (and of course vuepress) could benefit from this syntax later.

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

The funding of 1.25 ETH (232.98 USD @ $186.38/ETH) attached to this issue has been approved & issued to @think-in-universe.

• Learn more on the Gitcoin Issue Details page
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $126,440.16 more funded OSS Work available on the Gitcoin Issue Explorer