diff --git a/README.md b/README.mkd similarity index 67% rename from README.md rename to README.mkd index 7f249ce..6d42f55 100644 --- a/README.md +++ b/README.mkd @@ -14,21 +14,16 @@ The `sphook` executable in root directory of this repo is built on Linux 64bits The `sphook` binary is only tested on Linux virtual server and developer's laptop. If you need it for some other arch or operating system, build it, test it and report back or even better do PR here. -UPDATE 22/12/06: -for host running Ubuntu 18.04 and running go1.19.2 on laptop, building `sphook` required: +## Print footnotes/subheading issue -- cleaning up go.mod so it only has the first line `module ....` -- and deleting go.sum, cleaning cache, getting package cgo and running build like this: +Sandpoints aggregates Markdown files into a good old linear, well paginated, publication. Hugo by default doesn't allow for unique separation of subheaders and footnotes. If print is important check what's the change Hugo needs to handle it [well](https://github.com/gohugoio/hugo/issues/10932). -``` -rm go.sum -go clean -modcache -go get +With a patch in a forked Hugo's repository one needs to do something like this in SandpointsGitHook repo's `go.mod`: -go get github.com/pjbgf/sha1cd/cgo -GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build . -``` +`replace github.com/gohugoio/hugo v0.xxx => /path/to/patched/hugo/repo` + +change v0.xxx to respected Hugo's version and path to local Hugo's repo with a patch. ## Hugo's final output directory @@ -44,7 +39,7 @@ If you want to build it against another directory where Hugo will render its con hook.PublicHTMLPath = filepath.Join("/var", "www", "html", "sandpoints") ``` -change it there and rebuild it. +change it there and rebuild ## Install `sphook` in Gitea via its web ui