walcutt/searchable-jekyll-template
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

allow for using - and _ in the links

Browse Source
This commit is contained in:
psuwala 2021-12-31 17:09:28 +01:00 committed by Maxime Vaillancourt
parent a09b2dc505
commit 59b4652c61
2 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
_notes/your-first-note.md
View File

@ -17,6 +17,8 @@ To link to another note, you can use multiple syntaxes. The following four use t
Non-latin languages are supported too: [[안녕하세요]]. Non-latin languages are supported too: [[안녕하세요]].
Dashes and underscores in file names are supported, and may be omitted in the bracket link syntax. As an example, the `your-first-note.md` file can be linked to with [[your first note]] or [[your-first-note]], or even [[yOuR-FiRsT Note]].
In all cases, if the double-bracket link does not point to a valid note, the double brackets will still be shown, like this: [[there is no note that matches this link]]. In all cases, if the double-bracket link does not point to a valid note, the double brackets will still be shown, like this: [[there is no note that matches this link]].
Alternatively, you can use regular [Markdown syntax](https://www.markdownguide.org/getting-started/) for links, with a relative link to the other note, like this: [this is a Markdown link to the note about cats](/cats){: .internal-link}. Don't forget to use the `.internal-link` class to make sure the link is styled as an internal link (without the little arrow). Alternatively, you can use regular [Markdown syntax](https://www.markdownguide.org/getting-started/) for links, with a relative link to the other note, like this: [this is a Markdown link to the note about cats](/cats){: .internal-link}. Don't forget to use the `.internal-link` class to make sure the link is styled as an internal link (without the little arrow).

14
_plugins/bidirectional_links_generator.rb
View File

@ -15,10 +15,12 @@ class BidirectionalLinksGenerator < Jekyll::Generator
# anchor tag elements (<a>) with "internal-link" CSS class # anchor tag elements (<a>) with "internal-link" CSS class
all_docs.each do |current_note| all_docs.each do |current_note|
all_docs.each do |note_potentially_linked_to| all_docs.each do |note_potentially_linked_to|
title_from_filename = Regexp.escape(File.basename( note_title_regexp_pattern = Regexp.escape(
note_potentially_linked_to.basename, File.basename(
File.extname(note_potentially_linked_to.basename) note_potentially_linked_to.basename,
).gsub('_', ' ').gsub('-', ' ').capitalize) File.extname(note_potentially_linked_to.basename)
)
).gsub('\_', '[ _]').gsub('\-', '[ -]').capitalize
title_from_data = note_potentially_linked_to.data['title'] title_from_data = note_potentially_linked_to.data['title']
if title_from_data if title_from_data
@ -31,7 +33,7 @@ class BidirectionalLinksGenerator < Jekyll::Generator
# Replace double-bracketed links with label using note title # Replace double-bracketed links with label using note title
# [[A note about cats|this is a link to the note about cats]] # [[A note about cats|this is a link to the note about cats]]
current_note.content.gsub!( current_note.content.gsub!(
/\[\[#{title_from_filename}\|(.+?)(?=\])\]\]/i, /\[\[#{note_title_regexp_pattern}\|(.+?)(?=\])\]\]/i,
anchor_tag anchor_tag
) )
@ -52,7 +54,7 @@ class BidirectionalLinksGenerator < Jekyll::Generator
# Replace double-bracketed links using note filename # Replace double-bracketed links using note filename
# [[cats]] # [[cats]]
current_note.content.gsub!( current_note.content.gsub!(
/\[\[(#{title_from_filename})\]\]/i, /\[\[(#{note_title_regexp_pattern})\]\]/i,
anchor_tag anchor_tag
) )
end end