obsidian-wikilinks-converter

Convert Obsidian WikiLinks to GitHub-compatible Markdown links.

38|6|Updated Aug 4, 2025
One-click install
npx skills add https://github.com/hacket/ClaudeCodeTips --skill obsidian-wikilinks-converter
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: obsidian-wikilinks-converter
Source: https://github.com/hacket/ClaudeCodeTips/tree/main/.claude/skills/obsidian-wikilinks-converter
Command: npx skills add https://github.com/hacket/ClaudeCodeTips --skill obsidian-wikilinks-converter

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill converts Obsidian WikiLinks ([[...]]) to standard Markdown links (...) to ensure GitHub compatibility while preserving Obsidian functionality.

Core Features & Use Cases

  • Display Text Priority: If a WikiLink contains a pipe (|), the specified display text is used; otherwise the filename (without path and extension) is used as the display text.
  • Path Handling: Preserve relative paths; add a .md extension if missing; URL-encode spaces for GitHub compatibility.
  • Special Cases: [[README]] becomes README; [[folder/README]] becomes README.
  • Usage Patterns: Quick Start, batch conversion, dry-run previews, and per-file conversions.

Quick Start

  • Preview changes: python3 .claude/skills/obsidian-wikilinks-converter/scripts/convert.py --dry-run
  • Convert all README.md files: python3 .claude/skills/obsidian-wikilinks-converter/scripts/convert.py
  • Convert a specific file: python3 .claude/skills/obsidian-wikilinks-converter/scripts/convert.py --file path/to/file.md
  • Batch convert by directory: python3 .claude/skills/obsidian-wikilinks-converter/scripts/convert.py --root ./06-AI

Frequently Asked Questions about obsidian-wikilinks-converter

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I convert Obsidian WikiLinks to Markdown links for GitHub?

Convert WikiLinks ([[...]]) to standard Markdown links ([...](...)) using regex-based parsing. The converter preserves relative paths, appends .md extensions, URL-encodes spaces, and handles display text via pipe separators—making Obsidian notes GitHub-compatible while maintaining internal linking structure.

Can I preview WikiLink conversion changes before applying them?

Yes. Use the --dry-run flag to preview all conversion changes without modifying files. This lets you verify path normalization, display text extraction, and .md extension handling before committing changes to your README.md or other Markdown documents.

What happens to special cases like [[README]] during conversion?

Special cases are handled explicitly: [[README]] converts to [README](README.md) and [[folder/README]] becomes [README](folder/README.md). The converter recognizes README files, omits path prefixes from display text, and preserves relative directory structure in link targets.

Does the converter work on entire directories or just individual files?

The converter supports per-file, directory-wide, and batch workflows. Use --file for single files, --root for directory-level batch conversion, or run without flags to convert all README.md files across your project.

What limitations should I know about WikiLink conversion?

WikiLinks inside code blocks are skipped to preserve literal syntax. The converter requires relative paths and assumes .md file extensions. Display text depends on pipe separators; without them, filenames become display text, stripping paths and extensions.

Do I need to manually fix spaces in WikiLink paths after conversion?

No. The converter automatically URL-encodes spaces in paths for GitHub compatibility, transforming [[my file]] to [my file](my%20file.md) so links resolve correctly on GitHub without manual path editing.