lenra-io / lenra-io/docs

[Task] Add links to titles

Open
#86 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue hacktoberfest
Dominant language
CSS
Stars
5
Forks
0
PR merge metrics
No merged PRs in 30d

Description

What should be done

Add a link to all the h2+ titles.

Technical recommandation

The markdown generates an id on title but not pug. A id should be added when not present.

Ecological concerns

Avoid JavaScript event.

The best solution is to add the ID at compile time but it could be complicated...

If not possible, run JS to add the links when the page is loaded.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by locating the Pug compilation and heading-rendering entry points, then compare their output with the Markdown-generated heading IDs. Done means every h2 and deeper heading has an ID and a link without relying on a JavaScript event; verify the generated documentation pages.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, pug
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.