Skip to content

Commit

Permalink
fix(typo): wiklink => wikilink (#39)
Browse files Browse the repository at this point in the history
I copied the code from the README to start a project using this,
and ran into an issue due to the example code
referencing the package as `wiklink` rather than `wikilink`.

Did a find & replace in the project for `wiklink`,
replacing it with `wikilink`,
so the example code in the README should now be valid.
  • Loading branch information
nint8835 authored Aug 25, 2023
1 parent 4b8df0d commit 18e9309
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ To use goldmark-wikilink, import the `wikilink` package.
import "go.abhg.dev/goldmark/wikilink"
```

Then include the `wiklink.Extender` in the list of extensions
Then include the `wikilink.Extender` in the list of extensions
that you build your [`goldmark.Markdown`] with.

[`goldmark.Markdown`]: https://pkg.go.dev/github.com/yuin/goldmark#Markdown

```go
goldmark.New(
goldmark.WithExtensions(
&wiklink.Extender{},
&wikilink.Extender{},
),
// ...
)
Expand All @@ -61,7 +61,7 @@ to your `wikilink.Extender` when you install it.
goldmark.New(
goldmark.WithExtensions(
// ...
&wiklink.Extender{
&wikilink.Extender{
Resolver: myresolver,
},
),
Expand Down
2 changes: 1 addition & 1 deletion resolver.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ package wikilink

import "path/filepath"

// DefaultResolver is a minimal wiklink resolver that resolves wikilinks
// DefaultResolver is a minimal wikilink resolver that resolves wikilinks
// relative to the source page.
//
// It adds ".html" to the end of the target
Expand Down

0 comments on commit 18e9309

Please sign in to comment.