mathieudutour/gatsby-digital-garden

Include page mention excerpt from markdown files in ‘Referred in’

Open

#18 opened on Jun 19, 2020

View on GitHub
 (4 comments) (0 reactions) (0 assignees)JavaScript (98 forks)github user discovery
enhancementgood first issue

Repository metrics

Stars
 (686 stars)
PR merge metrics
 (PR metrics pending)

Description

Would it be possible to include excerpts from markdown files in the ‘Referred in’ section?

Currently, if the mention comes from notes originating from Roam, the parent block with the page mention is shown as a bullet point unter the page title. But for local markdown files, only the page title is given.

If it is possible to extract and display the sentence or the paragraph where the parent page mention is, or even showing the first paragraph of this parent note as a preview, it would be make ‘Referred in’ more content-rich for markdown files, and also appear to be more consistent with Roam notes.

Contributor guide

Research direction
Investigate how the 'Referred in' section currently extracts content for Roam notes and apply similar logic for markdown files. Look for the relevant plugin code that handles page mentions.
Tech stack
javascriptreact
Domain
frontend
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70