Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/j-siu/go-hugo-lc
Hugo site link checker written in golang.
https://github.com/j-siu/go-hugo-lc
go hugo markdown
Last synced: about 2 months ago
JSON representation
Hugo site link checker written in golang.
- Host: GitHub
- URL: https://github.com/j-siu/go-hugo-lc
- Owner: J-Siu
- License: mit
- Created: 2020-08-21T21:22:13.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-29T07:18:17.000Z (almost 2 years ago)
- Last Synced: 2024-10-19T17:28:30.049Z (3 months ago)
- Topics: go, hugo, markdown
- Language: Go
- Size: 35.2 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-hugo-lc [](https://www.paypal.com/donate/?business=HZF49NM9D35SJ&no_recurring=0¤cy_code=CAD)
Hugo site link checker written in Golang. Handy for checking internal link breakage after migration.
### Table Of Content
- [Table Of Content](#table-of-content)
- [Highlight](#highlight)
- [Limitation](#limitation)
- [Binary](#binary)
- [Compile](#compile)
- [Usage](#usage)
- [Repository](#repository)
- [Contributors](#contributors)
- [Change Log](#change-log)
- [License](#license)
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
```sh
go get github.com/J-Siu/go-hugo-lc
cd $GOPATH/src/github.com/J-Siu/go-hugo-lc
go install
```
### Usage
```sh
go-hugo-lc
```
```sh
go-hugo-lc v0.5.4
License : MIT License Copyright (c) 2023 John Siu
Support : https://github.com/J-Siu/go-hugo-lc/issues
Debug : export _DEBUG=true
Usage : go-hugo-lc
```
In Hugo site root:
```sh
go-hugo-lc https://example.com content public
```
Single page usage:
```sh
go-hugo-lc https://example.com content/post/post.md public
```
### Repository
- [go-hugo-lc](https://github.com/J-Siu/go-hugo-lc)
### Contributors
- [John Sing Dao Siu](https://github.com/J-Siu)
### 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
- v1.0.0
- Update to Go 1.20 and dependency
### License
The MIT License
Copyright (c) 2023 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.