🔀 Merge pull request #153 from davep/wikilinks

Add a plugin for handling wikilinks-style links

Author: davep

ChangeLog.md

@@ -1,5 +1,12 @@
 # Hike ChangeLog
 
+## Unreleased
+
+**Released: WiP**
+
+- Added basic support for wikilink style links.
+  ([#153](https://github.com/davep/hike/pull/153))
+
 ## v1.3.0
 
 **Released: 2026-03-03**

src/hike/markdown/__init__.py

@@ -0,0 +1,11 @@
+"""Markdown-related extensions for Hike."""
+
+##############################################################################
+# Local imports.
+from .wikilinks import wikilink_plugin
+
+##############################################################################
+# Exports.
+__all__ = ["wikilink_plugin"]
+
+### __init__.py ends here

src/hike/markdown/wikilinks.py

@@ -0,0 +1,80 @@
+"""A MarkdownIt plugin for parsing [[WikiLinks]]."""
+
+##############################################################################
+# Python imports.
+from pathlib import PurePosixPath
+from re import Pattern, compile
+from typing import Final
+
+##############################################################################
+# MarkdownIt imports.
+from markdown_it import MarkdownIt
+from markdown_it.rules_inline import StateInline
+
+##############################################################################
+_DETECT_WIKILINK: Final[Pattern[str]] = compile(r"\[\[(?P<content>[^\]]+)\]\]")
+"""Regular expression for detecting wikilinks."""
+
+
+##############################################################################
+def _make_href(target: str) -> str:
+    """Make a URL for the given wikilink target.
+
+    Args:
+        target: The target of the wikilink.
+
+    Returns:
+        A URL for the given wikilink target.
+    """
+    filename, _, anchor = target.strip().partition("#")
+    if filename and not PurePosixPath(filename).suffix:
+        filename = f"{filename}.md"
+    if filename and not anchor:
+        return filename
+    if anchor and not filename:
+        return f"#{anchor}"
+    return f"{filename}#{anchor}"
+
+
+##############################################################################
+def _handle_wikilink(state: StateInline, silent: bool) -> bool:
+    """MarkdownIt rule for parsing wikilinks.
+
+    Args:
+        state: The current inline parser state.
+        silent: Should we only work in detect mode?
+
+    Returns:
+        Whether a wikilink was successfully parsed.
+    """
+    if (link := _DETECT_WIKILINK.match(state.src, state.pos)) is None:
+        return False
+    if not (content := link["content"].strip()):
+        return False
+    target, _, text = content.partition("|")
+    if "\n" in target:
+        return False
+    if silent:
+        return True
+    token = state.push("link_open", "a", 1)
+    token.attrs = {"href": _make_href(target)}
+    token.markup = "[["
+    token.info = "wikilink"
+    display_token = state.push("text", "", 0)
+    display_token.content = (text or target).strip()
+    state.push("link_close", "a", -1)
+    state.pos = link.end()
+    return True
+
+
+##############################################################################
+def wikilink_plugin(markdown: MarkdownIt) -> None:
+    """MarkdownIt plugin to add wikilink support.
+
+    Args:
+        md: The MarkdownIt instance to extend.
+    """
+    markdown.inline.ruler.push("wikilink", _handle_wikilink)
+
+
+### wikilinks.py ends here

src/hike/messages/opening.py

@@ -37,6 +37,9 @@ class OpenLocation(Message):
     to_open: HikeLocation
     """The location to open."""
 
+    anchor: str | None = None
+    """An optional anchor to scroll to."""
+
 
 ##############################################################################
 @dataclass

src/hike/screens/main.py

@@ -256,7 +256,9 @@ async def _open_markdown(self, message: OpenLocation) -> None:
         if maybe_markdown(message.to_open) or await can_be_negotiated_to_markdown(
             message.to_open
         ):
-            self.query_one(Viewer).location = message.to_open
+            self.query_one(Viewer).goto_anchor_after_load(
+                message.anchor
+            ).location = message.to_open
             if load_configuration().focus_viewer_on_load:
                 self.query_one(Viewer).focus()
         else:

src/hike/widgets/viewer.py

@@ -48,6 +48,7 @@
 from ..commands import JumpToCommandLine
 from ..data import is_editable, load_configuration, looks_urllike
 from ..editor import Editor
+from ..markdown import wikilink_plugin
 from ..messages import CopyToClipboard, OpenLocation
 from ..support import is_copy_request_click, view_in_browser
 from ..types import HikeHistory, HikeLocation
@@ -175,8 +176,10 @@ def __init__(self) -> None:
         """Initialise the widget."""
         super().__init__(
             open_links=False,
-            parser_factory=lambda: MarkdownIt("gfm-like").use(
-                front_matter.front_matter_plugin
+            parser_factory=lambda: (
+                MarkdownIt("gfm-like")
+                .use(front_matter.front_matter_plugin)
+                .use(wikilink_plugin)
             ),
         )
 
@@ -249,6 +252,9 @@ class Viewer(Vertical, can_focus=False):
     _source: var[str] = var("")
     """The source of the Markdown we're viewing."""
 
+    _seek_anchor: var[str | None] = var(None)
+    """An optional anchor to seek to once the document is loaded."""
+
     def compose(self) -> ComposeResult:
         """Compose the content of the viewer."""
         yield ViewerTitle()
@@ -456,6 +462,9 @@ async def _update_markdown(self, message: Loaded) -> None:
         if front_matter_had_focus and not hikedown.front_matter:
             self.query_one(MarkdownScroll).focus()
         self.query_one(FrontMatter).front_matter = hikedown.front_matter
+        if self._seek_anchor:
+            self.query_one(HikeDown).goto_anchor(self._seek_anchor)
+            self._seek_anchor = None
         if (
             message.remember
             and self.location
@@ -476,6 +485,18 @@ def reload(self) -> None:
         """Reload the current document."""
         self._visit(self.location, remember=False, preserve_position=True)
 
+    def goto_anchor_after_load(self, anchor: str | None) -> Self:
+        """Go to an anchor after the document is loaded.
+
+        Args:
+            anchor: The anchor to go to.
+
+        Returns:
+            Self.
+        """
+        self._seek_anchor = anchor
+        return self
+
     def goto(self, history_location: int) -> None:
         """Go to a specific location in history."""
         if self.history.current_location != history_location:
@@ -538,25 +559,28 @@ def _handle_link(self, message: Markdown.LinkClicked) -> None:
             )
             return
 
+        # Having eliminated URLs, it's likely something more local. First
+        # off, on the off-chance that there's an anchor involved still...
+        file_name, _, anchor = message.href.partition("#")
+
+        # Some sort of internal anchor perhaps?
+        if anchor and not file_name:
+            message.markdown.goto_anchor(anchor)
+            return
+
         # A local file that exists?
-        if (local_file := Path(message.href).expanduser()).exists():
-            self.post_message(OpenLocation(local_file.resolve()))
+        if (local_file := Path(file_name).expanduser()).exists():
+            self.post_message(OpenLocation(local_file.resolve(), anchor))
             return
 
         # A local file relative to the current location?
         if (
             isinstance(self.location, Path)
-            and (local_file := self.location.parent / Path(message.href))
+            and (local_file := self.location.parent / Path(file_name))
             .absolute()
             .exists()
         ):
-            self.post_message(OpenLocation(local_file))
-            return
-
-        # Some sort of internal anchor perhaps?
-        if message.href.startswith("#") and message.markdown.goto_anchor(
-            message.href[1:]
-        ):
+            self.post_message(OpenLocation(local_file, anchor))
             return
 
         self.notify(