John Siu Blog

Tech - Business Tool, Personal Toys

Go-Hugo-LC - Link Checker

☰ Table of Content

Hugo site link checker written in Golang.

Handy for checking internal link breakage after migration.

Highlight

  • Check using local content directory
  • Does not use markdown parser
  • Golang standard library only

Limitation

  • Verify internal link only
  • Links need server side redirection will be marked as fail
  • Only detect links in markdown format []()

All 3 may improve in future.

Binary

https://github.com/J-Siu/go-hugo-lc/releases

Compile

1
2
3
go get github.com/J-Siu/go-hugo-lc
cd $GOPATH/src/github.com/J-Siu/go-hugo-lc
go install

Usage

1
go-hugo-lc
1
2
3
4
5
go-hugo-lc v0.5.4
License : MIT License Copyright (c) 2021 John Siu
Support : https://github.com/J-Siu/go-hugo-lc/issues
Debug   : export _DEBUG=true
Usage   : go-hugo-lc <baseURL> <content dir> <public dir>

In Hugo site root:

1
go-hugo-lc https://example.com content public

Single page usage:

1
go-hugo-lc https://example.com content/post/post.md public

Repository

Contributors

Change Log

  • 0.5
    • Initial Commit
  • 0.5.1
    • Use mod
  • 0.5.2
    • Use github.com/J-Siu/go-helper
  • 0.5.3
    • Use Go routine
  • 0.5.4
    • Use github.com/J-Siu/go-ver
    • Remove site struct
  • 0.6.0
    • Use Go 1.16

License

The MIT License

Copyright (c) 2021 John Siu

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

John Siu

Update: 2022-05-18
comments powered by Disqus