Skip to content

Commit 7a424b5

Browse files
JayJayArrmre
authored andcommitted
Add Wikilink page in recipes
1 parent 928e684 commit 7a424b5

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

astro.config.mjs

+1
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ export default defineConfig({
6363
link: "/recipes/root-dir",
6464
},
6565
{ label: "Pretty URLs", link: "/recipes/pretty-urls" },
66+
{ label: "Wikilinks", link: "/recipes/wikilinks" },
6667
],
6768
},
6869
{

src/content/docs/recipes/wikilinks.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: Wikilinks
3+
---
4+
5+
Lychee can check Wikilinks in Markdown files as long as they provide a path to the linked ressource.
6+
7+
```markdown
8+
# ✅ Good - links can be checked
9+
10+
[[https://example.com/docs/]]
11+
[[./another/markdown/file.md]]
12+
13+
# ❌ Bad - Will not work
14+
15+
[[another-markdown-page]]
16+
```
17+
18+
Tools like e.g. [Obsidian](https://obsidian.md/) use the second (bad) form of link, using only the file name without path or file extension.
19+
20+
Lychee has no possibility of determining the correct path for this file as it could be:
21+
22+
- in the same directory
23+
- in a subdirectory
24+
- in a parent directory
25+
26+
A recursive search of all those options is currently not supported.

0 commit comments

Comments
 (0)