foambubble/foam

Option to use internal standard Markdown Links instead of WikiLinks

Closed

#1,353 opened on Apr 29, 2024

View on GitHubContributor guide
 (4 comments) (6 reactions) (0 assignees)TypeScript (623 forks)batch import
foam-vscodegood first issuehelp wanted

Repository metrics

Stars
 (14,407 stars)
PR merge metrics
 (Avg merge 4h 22m) (1 merged PR in 30d)

Description

Is your feature request related to a problem? Please describe.

The feature is not related to a problem.

Describe the solution you'd like

I use Foam to manage my markdown files library and then I use Hugo to generate a static site to browse my PKM. As you may know Hugo isn't compatible with WikiLinks.

So for those who use Foam and a static site generator as Hugo it would be great to have to possibility, via option in configuration, to use internal standard Markdown Links instead of WikiLinks. This has been done in this foam fork. But this fork is not complete on only some features proposed by Foam are available.

Would it be possible to implement this fork into the Foam code and let the user choose between WikiLinks or Standard Internal Markdown Links ?

Describe alternatives you've considered

No alternative considered.

Screenshots or Videos

No response

Contributor guide

Research direction
Examine the referenced fork (theowenyoung/foam) to understand how it implements standard Markdown links. Identify how Foam currently handles WikiLinks (likely in the markdown provider or link provider files). Propose a configuration flag to switch between link formats, ensuring compatibility with Hugo and other static site generators. Discuss in the issue comments and reach out to maintainers for guidance before coding.
Tech stack
typescriptnodejs
Domain
tooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
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
TypeScriptVSCode extension developmentFoam codebase structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60