GoogleCloudPlatform / GoogleCloudPlatform/open-knowledge-format

Permit MediaWiki-style internal links syntax (`[[concept]]`) in OKF Markdown

Open
#9 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
467
Forks
35
Avg merge
9m
Merged PRs (30d)
1

Description

How about (a future version of) the OKF spec explicitly permit MediaWiki-style internal links syntax in OKF Markdown?

So basically allow `[[topic/concept]]` instead of full `[Topic's Concept](topic/concept)` as an alternative.

Even though not strictly [CommonMark](https://commonmark.org/)-compliant (which [OKF doesn't require anyway](https://github.com/search?q=repo%3AGoogleCloudPlatform%2Fopen-knowledge-format+CommonMark&type=code)),

this is (very) common nowadays, see for example:

- https://obsidian.md/help/links
- https://www.mediawiki.org/wiki/Help:Links
- https://docs.enola.dev/specs/markdown-magic-link
- https://quartz.jzhao.xyz/features/wikilinks
- https://github.com/orbikm/mkdocs-ezlinks-plugin

Contributor guide

Open the contributing guide

Research direction

Start by locating the OKF Markdown specification and its syntax or validation guidance; no specific file or test is named in the issue. Compare the proposed [[topic/concept]] form with the existing full-link form and the referenced CommonMark constraints, then document the accepted behavior and any required examples or validation updates.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.