OrgWiki/go-org-orgwiki
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

html: Support pretty relative links

Browse source 
Hugo defaults to serving files with pretty urls [1] - this means
`/posts/foo.org` is served at `/posts/foo/`. This works because servers
default to serving index.html when a directory is specified and hugo renders
the post to `/posts/foo/index.html` instead of `/posts/foo.html`. To make
relative links work we need to (1) remove the fake `foo/` subdirectory from
unrooted links and (2) replace any `.org` suffix with `/`.

[1] https://gohugo.io/content-management/urls/#pretty-urls
This commit is contained in:
Niklas Fasching 2021-01-02 19:37:17 +01:00
parent 84d56e9562
commit 5dadf8c4c2
2 changed files with 38 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

14
org/html_writer.go
View file

@ -15,8 +15,9 @@ import (
// HTMLWriter exports an org document into a html document.
type HTMLWriter struct {
ExtendingWriter Writer
HighlightCodeBlock func(source, lang string, inline bool) string
ExtendingWriter Writer
HighlightCodeBlock func(source, lang string, inline bool) string
PrettyRelativeLinks bool
strings.Builder
document *Document
@ -342,7 +343,14 @@ func (w *HTMLWriter) WriteRegularLink(l RegularLink) {
if l.Protocol == "file" {
url = url[len("file:"):]
}
if (l.Protocol == "file" || l.Protocol == "") && strings.HasSuffix(url, ".org") {
if isRelative := l.Protocol == "file" || l.Protocol == ""; isRelative && w.PrettyRelativeLinks {
if !strings.HasPrefix(url, "/") {
url = "../" + url
}
if strings.HasSuffix(url, ".org") {
url = strings.TrimSuffix(url, ".org") + "/"
}
} else if isRelative && strings.HasSuffix(url, ".org") {
url = strings.TrimSuffix(url, ".org") + ".html"
}
if prefix := w.document.Links[l.Protocol]; prefix != "" {

27
org/html_writer_test.go
View file

@ -42,3 +42,30 @@ func TestExtendedHTMLWriter(t *testing.T) {
t.Errorf("WriteText method of extending writer was not called: CallCount %d", extendedWriter.callCount)
}
}
var prettyRelativeLinkTests = map[string]string{
"[[/hello.org][hello]]": `<p><a href="/hello/">hello</a></p>`,
"[[hello.org][hello]]": `<p><a href="../hello/">hello</a></p>`,
"[[file:/hello.org]]": `<p><a href="/hello/">/hello/</a></p>`,
"[[file:hello.org]]": `<p><a href="../hello/">../hello/</a></p>`,
"[[http://hello.org]]": `<p><a href="http://hello.org">http://hello.org</a></p>`,
"[[/foo.png]]": `<p><img src="/foo.png" alt="/foo.png" title="/foo.png" /></p>`,
"[[foo.png]]": `<p><img src="../foo.png" alt="../foo.png" title="../foo.png" /></p>`,
"[[/foo.png][foo]]": `<p><a href="/foo.png">foo</a></p>`,
"[[foo.png][foo]]": `<p><a href="../foo.png">foo</a></p>`,
}
func TestPrettyRelativeLinks(t *testing.T) {
for org, expected := range prettyRelativeLinkTests {
t.Run(org, func(t *testing.T) {
writer := NewHTMLWriter()
writer.PrettyRelativeLinks = true
actual, err := New().Silent().Parse(strings.NewReader(org), "./prettyRelativeLinkTests.org").Write(writer)
if err != nil {
t.Errorf("%s\n got error: %s", org, err)
} else if actual := strings.TrimSpace(actual); actual != expected {
t.Errorf("%s:\n%s'", org, diff(actual, expected))
}
})
}
}