From 2efc033afe605b68e4c8fa761a3b8fa3cf44e458 Mon Sep 17 00:00:00 2001 From: Simon Date: Wed, 3 Jan 2024 21:39:35 +0000 Subject: [PATCH] docs(#5): document how wiki links are keyed --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 4c64552..107f1c0 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,8 @@ This plugin will now parse all Wiki Links formatted for example, `[[Eleventy.js Using the vertical bar (`|`) you can change the text used to display a link. This can be useful when you want to work a link into a sentence without using the title of the file, for example: `[[Eleventy.js Interlink Plugin|custom display text]]` appears as [custom display text](https://www.photogabble.co.uk/projects/eleventyjs-interlink-plugin/). +> NOTE: By default this plugin will use the `title` front-matter attribute of your pages or one of the aliases (as detailed below). + ### Aliases Aliases provide you a way of referencing a file using different names, use the `aliases` property in your font matter to list one or more aliases that can be used to reference the file from a Wiki Link. For example, you might add _AI_ as an alias of a file titled _Artificial Intelligence_ which would then be linkable via `[[AI]]`.