derhuerst/technical-docs-cli

permalinks for each paragraph?

Open

#1 opened on Sep 13, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (0 forks)github user discovery
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (0 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

as seen at living in the future.

One could hash a normalised form of the paragraph to compute its ID.

It would make sense to implement this functionality as a remark plugin that can be moved into a separate npm package.

Contributor guide

Research direction
Create a remark plugin that normalizes paragraph text, computes a hash, and adds an anchor link. Implement as a separate npm package.
Tech stack
javascript
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.jsnpm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65