rust-lang / rust-lang/mdBook

Link Anything

Open
#2,299 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C-enhancement
Dominant language
Rust
Stars
22.2k
Forks
1.9k
PR merge metrics
PR metrics pending

Description

Problem

It is very useful with spec-md to be able to share a link to anything:
https://spec-md.com/#sel-EAHHFCAACCyFm2Q

It would be great if we could include this functionality in mdBook.

Proposed Solution

https://github.com/leebyron/spec-md/blob/main/src/client/linkSelections.js is the implementation for md-spec

https://github.com/WesleyAC/deeplinks is another implementation

Notes

No response

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.

Research direction

Start by reading spec-md's src/client/linkSelections.js and the deeplinks implementation referenced in the issue. Then compare their approaches with mdBook's existing architecture; done means mdBook can generate links to arbitrary content selections as described in the example.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, rust
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.