35 Commits

Author SHA1 Message Date
Alex Schroeder
faf9198edd Add sitemap command and handler 2026-01-02 22:30:02 +01:00
Alex Schroeder
e9666a5ec5 Fixed missing command
Outside of the test it always got an empty index and therefore never
found any missing pages.
2026-01-02 14:33:42 +01:00
Alex Schroeder
f71a0e9780 Feeds page through yearly archives, too 2026-01-01 17:44:44 +01:00
Alex Schroeder
aca1d82fe0 Feed subcommand uses page name to determine date
The pubDate of the items in an archive feed should not be based on the
last modified time of the file because mass edits are irrelevant in
this context. The intended creation time is more important.
2025-12-31 20:28:41 +01:00
Alex Schroeder
290ad16e09 Change {{.Html}} to {{.HTML}} in the themes folder
Add note to the release page.
2025-12-06 14:24:19 +01:00
Alex Schroeder
ad1732f57f Fix all gocritic and golint issues 2025-12-06 14:10:20 +01:00
Alex Schroeder
67120af7cc Run goimports and rearrange imports 2025-12-06 13:38:46 +01:00
Alex Schroeder
c186253a25 Add check and fix targets to Makefile 2025-12-06 13:35:34 +01:00
Alex Schroeder
d0d4545f74 Ignore some errors when generating a static site
When using the static subcommand:

- ignore existing directory;
- remove existing files before creating a link;
- report any remaining errors.
2025-12-06 13:35:31 +01:00
Alex Schroeder
c32f087af4 Add shrink option to static command 2025-12-05 14:22:21 +01:00
Alex Schroeder
f657ac60a3 Extract MIME type detection by extension 2025-12-04 23:33:46 +01:00
Alex Schroeder
16ae6cc143 Don't load the index for notifyCli
It's not required for the command-line and improves execution time.
2025-11-08 23:33:33 +01:00
Alex Schroeder
e041c5ecae Fiddle with the wording of the README 2025-09-29 16:53:25 +02:00
Alex Schroeder
3078d63890 Release v1.19 2025-09-28 19:38:52 +02:00
Alex Schroeder
143ecb8a0a Update release info 2025-09-26 00:34:37 +02:00
Alex Schroeder
d66aa03a2d Document missing attributes of the feed template 2025-09-24 08:30:44 +02:00
Alex Schroeder
64954ddf5d Use & instead of & in the feed test 2025-09-24 08:30:21 +02:00
Alex Schroeder
a1d6ebfdff Fix ampersand quoting in feed.html 2025-09-22 23:15:42 +02:00
Alex Schroeder
db3a3f5009 Remove the .git suffix from the module
This counters the change in 2092b57. The .git suffix is technically
correct for the git repository but results in a binary called
"oddmu.git" which is incorrect.
2025-09-22 20:22:07 +02:00
Alex Schroeder
ece9649e3d Test for complete feeds 2025-09-22 13:44:58 +02:00
Alex Schroeder
23074cdd58 Video width 100% in CSS 2025-09-22 13:34:59 +02:00
Alex Schroeder
06c07209a2 Add test for feed command 2025-09-21 23:24:44 +02:00
Alex Schroeder
7b2a835729 Add feed pagination 2025-09-21 23:24:24 +02:00
Alex Schroeder
d0fe534f8e Explicitly gzip the .tar.gz file 2025-09-21 22:18:33 +02:00
Alex Schroeder
ac7de17a87 Use better globbing in the Makefile 2025-09-11 22:12:51 +02:00
Alex Schroeder
84e6a757b2 Upload the README, too 2025-09-11 22:12:40 +02:00
Alex Schroeder
2dfb2afbf5 Add a paragraph about "go install" 2025-09-11 22:11:48 +02:00
Alex Schroeder
2092b5777c Switch module identifier
From alexschroeder.ch/cgit/oddmu to src.alexschroeder.ch/oddmu.git
2025-09-02 23:00:36 +02:00
Alex Schroeder
f635cb738a go fmt 2025-09-01 17:40:17 +02:00
Alex Schroeder
da398a3315 Fix feed title and add test 2025-08-31 22:08:43 +02:00
Alex Schroeder
7315abd5bb Check for zero page names 2025-08-31 21:56:24 +02:00
Alex Schroeder
b39901b244 More man page fiddling 2025-08-31 21:47:23 +02:00
Alex Schroeder
bb4843c2f4 Updated oddmu-releases(7) 2025-08-31 16:29:35 +02:00
Alex Schroeder
816c981200 More cross-linking on the man pages 2025-08-31 16:28:22 +02:00
Alex Schroeder
89d550a1a4 Add feed subcommand 2025-08-31 13:13:44 +02:00
120 changed files with 1595 additions and 851 deletions

View File

@@ -10,6 +10,10 @@ help:
@echo " runs program, offline"
@echo make test
@echo " runs the tests without log output"
@echo make check
@echo " checks the code with golint and gocritic"
@echo make fix
@echo " fixes formatting issues with goimports instead of go fmt"
@echo make docs
@echo " create man pages from text files"
@echo make build
@@ -34,6 +38,14 @@ test:
rm -rf testdata/*
go test -shuffle on .
check:
golint
gocritic check
fix:
goimports -w *.go
run:
go run .
@@ -73,8 +85,8 @@ oddmu-windows-amd64.tar.gz: oddmu.exe
$< *.md man/*.[157].{html,md} themes/
%.tar.gz: %
tar --create --file $@ --transform='s/^$</oddmu/' --transform='s/^/oddmu\//' --exclude='*~' \
$< *.html Makefile *.socket *.service *.md man/Makefile man/*.1 man/*.5 man/*.7 themes/
tar --create --gzip --file $@ --transform='s/^$</oddmu/' --transform='s/^/oddmu\//' --exclude='*~' \
$< *.html Makefile *.socket *.service *.md man/Makefile man/*.[157] themes/
priv:
sudo setcap 'cap_net_bind_service=+ep' oddmu

View File

@@ -8,20 +8,18 @@ with Markdown files, turning them into HTML files. HTML templates
allow the customisation of headers, footers and styling. There are no
plugins.
Oddμ is well suited as a self-hosted, single-user web application,
when there is no need for collaboration on the site itself. Links and
email connect you to the rest of the net. The wiki can be public or
private.
Oddμ is well suited as a self-hosted, single-user web application.
Edit the pages from your phone or laptop, while you're on the move.
If the site is public, use a regular web server as a proxy to make
people log in before making changes. As there is no version history,
it is not possible to undo vandalism and spam. Only grant write-access
it is not easy to undo vandalism and spam. Only grant write-access
to people you trust.
If the site is private, running on a local machine and unreachable
from the Internet, no such precautions are necessary.
Oddμ is well suited as a secondary medium for a close-knit group:
This makes Oddμ well suited as a secondary medium for a close-knit group:
collaboration and conversation happens elsewhere, in chat, on social
media. The wiki serves as the text repository that results from these
discussions.
@@ -43,7 +41,7 @@ Other files can be uploaded and images (ending in `.jpg`, `.jpeg`,
## Documentation
This project uses man(1) pages. They are generated from text files
This project uses man pages. They are generated from text files
using [scdoc](https://git.sr.ht/~sircmpwn/scdoc). These are the files
available:
@@ -108,6 +106,14 @@ Static site generator:
This man page documents the "html" subcommand to generate HTML from
Markdown pages from the command line.
[oddmu-feed(1)](https://alexschroeder.ch/view/oddmu/oddmu-feed.1):
This man page documents the "feed" subcommand to generate a feed from
Markdown pages from the command line.
[oddmu-sitemap(1)](https://alexschroeder.ch/view/oddmu/oddmu-sitemap.1):
This man page documents the "sitemap" subcommand to generate the
static sitemap from the command line.
[oddmu-static(1)](https://alexschroeder.ch/view/oddmu/oddmu-static.1):
This man page documents the "static" subcommand to generate an entire
static website from the command line, avoiding the need to run Oddmu
@@ -253,6 +259,7 @@ high-level introduction to the various source files.
- `preview.go` implements the `/preview` handler
- `score.go` implements the page scoring when showing search results
- `search.go` implements the `/search` handler
- `sitemap.go` implements the `/sitemap` handler
- `snippets.go` implements the page summaries for search results
- `templates.go` implements template loading and reloading
- `tokenizer.go` implements the various tokenizers used

View File

@@ -2,13 +2,14 @@ package main
import (
"encoding/json"
"github.com/gomarkdown/markdown/ast"
"github.com/gomarkdown/markdown/parser"
"io"
"log"
"net/http"
"os"
"sync"
"github.com/gomarkdown/markdown/ast"
"github.com/gomarkdown/markdown/parser"
)
// useWebfinger indicates whether Oddmu looks up the profile pages of fediverse accounts. To enable this, set the
@@ -38,7 +39,7 @@ func init() {
// accountLink links a social media accountLink like @accountLink@domain to a profile page like https://domain/user/accountLink. Any
// accountLink seen for the first time uses a best guess profile URI. It is also looked up using webfinger, in parallel. See
// lookUpAccountUri. If the lookup succeeds, the best guess is replaced with the new URI so on subsequent requests, the
// lookUpAccountURI. If the lookup succeeds, the best guess is replaced with the new URI so on subsequent requests, the
// URI is correct.
func accountLink(p *parser.Parser, data []byte, offset int) (int, ast.Node) {
data = data[offset:]
@@ -56,9 +57,8 @@ func accountLink(p *parser.Parser, data []byte, offset int) (int, ast.Node) {
if d != 0 {
// more than one @ is invalid
return 0, nil
} else {
d = i + 1 // skip @ of domain
}
d = i + 1 // skip @ of domain
}
i++
}
@@ -79,7 +79,7 @@ func accountLink(p *parser.Parser, data []byte, offset int) (int, ast.Node) {
log.Printf("Looking up %s\n", account)
uri = "https://" + string(domain) + "/users/" + string(user[1:])
accounts.uris[string(account)] = uri // prevent more lookings
go lookUpAccountUri(string(account), string(domain))
go lookUpAccountURI(string(account), string(domain))
}
link := &ast.Link{
AdditionalAttributes: []string{`class="account"`},
@@ -90,9 +90,9 @@ func accountLink(p *parser.Parser, data []byte, offset int) (int, ast.Node) {
return i, link
}
// lookUpAccountUri is called for accounts that haven't been seen before. It calls webfinger and parses the JSON. If
// lookUpAccountURI is called for accounts that haven't been seen before. It calls webfinger and parses the JSON. If
// possible, it extracts the link to the profile page and replaces the entry in accounts.
func lookUpAccountUri(account, domain string) {
func lookUpAccountURI(account, domain string) {
uri := "https://" + domain + "/.well-known/webfinger"
resp, err := http.Get(uri + "?resource=acct:" + account)
if err != nil {

View File

@@ -1,8 +1,9 @@
package main
import (
"github.com/stretchr/testify/assert"
"testing"
"github.com/stretchr/testify/assert"
)
func TestWebfingerParsing(t *testing.T) {

View File

@@ -48,15 +48,17 @@ func appendHandler(w http.ResponseWriter, r *http.Request, name string) {
return
}
}
http.Redirect(w, r, "/view/" + nameEscape(name), http.StatusFound)
http.Redirect(w, r, "/view/"+nameEscape(name), http.StatusFound)
}
func (p *Page) append(body []byte) {
// ensure an empty line at the end
if bytes.HasSuffix(p.Body, []byte("\n\n")) {
} else if bytes.HasSuffix(p.Body, []byte("\n")) {
switch {
case bytes.HasSuffix(p.Body, []byte("\n\n")):
// two newlines, nothing to add
case bytes.HasSuffix(p.Body, []byte("\n")):
p.Body = append(p.Body, '\n')
} else {
default:
p.Body = append(p.Body, '\n', '\n')
}
p.Body = append(p.Body, body...)

View File

@@ -1,13 +1,14 @@
package main
import (
"github.com/stretchr/testify/assert"
"net/http"
"net/url"
"os"
"regexp"
"testing"
"time"
"github.com/stretchr/testify/assert"
)
func TestEmptyLineAdd(t *testing.T) {

View File

@@ -2,11 +2,12 @@ package main
import (
"archive/zip"
"github.com/stretchr/testify/assert"
"net/http"
"os"
"strings"
"testing"
"github.com/stretchr/testify/assert"
)
func TestArchive(t *testing.T) {

View File

@@ -38,7 +38,7 @@ func (p *Page) notify() error {
return err
}
}
p.renderHtml() // to set hashtags
p.renderHTML() // to set hashtags
for _, hashtag := range p.Hashtags {
err := addLink(path.Join(dir, hashtag), false, link, re)
if err != nil {
@@ -98,12 +98,13 @@ func addLinkWithDate(name, link string, re *regexp.Regexp) error {
if loc[0] >= 14 {
re := regexp.MustCompile(`(?m)^## (\d\d\d\d-\d\d-\d\d)\n`)
m := re.Find(p.Body[loc[0]-14 : loc[0]])
if m == nil {
switch {
case m == nil:
// not a date: insert date, don't move insertion point
} else if string(p.Body[loc[0]-11:loc[0]-1]) == date {
case string(p.Body[loc[0]-11:loc[0]-1]) == date:
// if the date is our date, don't add it, don't move insertion point
addDate = false
} else {
default:
// if the date is not out date, move the insertion point
loc[0] -= 14
}
@@ -148,10 +149,9 @@ func addLink(name string, mandatory bool, link string, re *regexp.Regexp) error
if mandatory {
p = &Page{Name: name, Body: []byte(link)}
return p.save()
} else {
// Skip non-existing files: no error
return nil
}
// Skip non-existing files: no error
return nil
}
org := string(p.Body)
addLinkToPage(p, link, re)

View File

@@ -1,11 +1,12 @@
package main
import (
"github.com/stretchr/testify/assert"
"os"
"regexp"
"testing"
"time"
"github.com/stretchr/testify/assert"
)
// Note TestEditSaveChanges and TestAddAppendChanges.
@@ -17,7 +18,7 @@ func TestAddLinkToPageWithNoList(t *testing.T) {
re := regexp.MustCompile(`(?m)^\* \[[^\]]+\]\(2025-08-08\)\n`)
link := "* [2025-08-08](2025-08-08)\n"
addLinkToPage(p, link, re)
assert.Equal(t, title + "\n\n" + link, string(p.Body))
assert.Equal(t, title+"\n\n"+link, string(p.Body))
}
func TestAddLinkToPageWithOlderLink(t *testing.T) {
@@ -28,7 +29,7 @@ func TestAddLinkToPageWithOlderLink(t *testing.T) {
re := regexp.MustCompile(`(?m)^\* \[[^\]]+\]\(2025-08-10\)\n`)
link := "* [2025-08-10](2025-08-10)\n"
addLinkToPage(p, link, re)
assert.Equal(t, title + "\n" + link + old, string(p.Body))
assert.Equal(t, title+"\n"+link+old, string(p.Body))
}
func TestAddLinkToPageBetweenToExistingLinks(t *testing.T) {
@@ -39,7 +40,7 @@ func TestAddLinkToPageBetweenToExistingLinks(t *testing.T) {
re := regexp.MustCompile(`(?m)^\* \[[^\]]+\]\(2025-08-09\)\n`)
link := "* [2025-08-09](2025-08-09)\n"
addLinkToPage(p, link, re)
assert.Equal(t, title + new + link + old, string(p.Body))
assert.Equal(t, title+new+link+old, string(p.Body))
}
func TestAddLinkToPageBetweenToExistingLinks2(t *testing.T) {
@@ -50,7 +51,7 @@ func TestAddLinkToPageBetweenToExistingLinks2(t *testing.T) {
re := regexp.MustCompile(`(?m)^\* \[[^\]]+\]\(2025-08-08\)\n`)
link := "* [2025-08-08](2025-08-08)\n"
addLinkToPage(p, link, re)
assert.Equal(t, title + new + link + old, string(p.Body))
assert.Equal(t, title+new+link+old, string(p.Body))
}
func TestAddLinkToPageAtTheEnd(t *testing.T) {
@@ -61,7 +62,7 @@ func TestAddLinkToPageAtTheEnd(t *testing.T) {
re := regexp.MustCompile(`(?m)^\* \[[^\]]+\]\(2025-08-07\)\n`)
link := "* [2025-08-07](2025-08-07)\n"
addLinkToPage(p, link, re)
assert.Equal(t, title + new + old + link, string(p.Body))
assert.Equal(t, title+new+old+link, string(p.Body))
}
func TestChanges(t *testing.T) {
@@ -119,9 +120,9 @@ func TestChangesWithList(t *testing.T) {
p.notify()
s, err := os.ReadFile("testdata/changes/changes.md")
assert.NoError(t, err)
new_line := "* [testdata/changes/alex](alex)\n"
newLine := "* [testdata/changes/alex](alex)\n"
// new line was added at the beginning of the list
assert.Equal(t, intro+d+new_line+line, string(s))
assert.Equal(t, intro+d+newLine+line, string(s))
}
func TestChangesWithOldList(t *testing.T) {
@@ -136,9 +137,9 @@ func TestChangesWithOldList(t *testing.T) {
p.notify()
s, err := os.ReadFile("testdata/changes/changes.md")
assert.NoError(t, err)
new_line := "* [testdata/changes/alex](alex)\n"
newLine := "* [testdata/changes/alex](alex)\n"
// new line was added at the beginning of the list
assert.Equal(t, intro+d+new_line+"\n"+y+line, string(s))
assert.Equal(t, intro+d+newLine+"\n"+y+line, string(s))
}
func TestChangesWithOldDisappearingListAtTheEnd(t *testing.T) {
@@ -153,9 +154,9 @@ func TestChangesWithOldDisappearingListAtTheEnd(t *testing.T) {
p.notify()
s, err := os.ReadFile("testdata/changes/changes.md")
assert.NoError(t, err)
new_line := "* [testdata/changes/alex](alex)\n"
newLine := "* [testdata/changes/alex](alex)\n"
// new line was added at the beginning of the list, with the new date, and the old date disappeared
assert.Equal(t, intro+d+new_line, string(s))
assert.Equal(t, intro+d+newLine, string(s))
}
func TestChangesWithOldDisappearingListInTheMiddle(t *testing.T) {
@@ -172,9 +173,9 @@ func TestChangesWithOldDisappearingListInTheMiddle(t *testing.T) {
p.notify()
s, err := os.ReadFile("testdata/changes/changes.md")
assert.NoError(t, err)
new_line := "* [testdata/changes/alex](alex)\n"
newLine := "* [testdata/changes/alex](alex)\n"
// new line was added at the beginning of the list, with the new date, and the old date disappeared
assert.Equal(t, intro+d+new_line+"\n"+yy+other, string(s))
assert.Equal(t, intro+d+newLine+"\n"+yy+other, string(s))
}
func TestChangesWithListAtTheTop(t *testing.T) {
@@ -187,9 +188,9 @@ func TestChangesWithListAtTheTop(t *testing.T) {
p.notify()
s, err := os.ReadFile("testdata/changes/changes.md")
assert.NoError(t, err)
new_line := "* [testdata/changes/alex](alex)\n"
newLine := "* [testdata/changes/alex](alex)\n"
// new line was added at the top, no error due to missing introduction
assert.Equal(t, d+new_line+line, string(s))
assert.Equal(t, d+newLine+line, string(s))
}
func TestChangesWithNoList(t *testing.T) {
@@ -202,9 +203,9 @@ func TestChangesWithNoList(t *testing.T) {
p.notify()
s, err := os.ReadFile("testdata/changes/changes.md")
assert.NoError(t, err)
new_line := "* [testdata/changes/alex](alex)\n"
newLine := "* [testdata/changes/alex](alex)\n"
// into is still there and a new list was started
assert.Equal(t, intro+"\n\n"+d+new_line, string(s))
assert.Equal(t, intro+"\n\n"+d+newLine, string(s))
}
func TestChangesWithUpdate(t *testing.T) {
@@ -219,9 +220,9 @@ func TestChangesWithUpdate(t *testing.T) {
p.notify()
s, err := os.ReadFile("testdata/changes/changes.md")
assert.NoError(t, err)
new_line := "* [testdata/changes/alex](alex)\n"
newLine := "* [testdata/changes/alex](alex)\n"
// the change was already listed, but now it moved up and has a new title
assert.Equal(t, intro+d+new_line+other, string(s))
assert.Equal(t, intro+d+newLine+other, string(s))
}
func TestChangesWithNoChangeToTheOrder(t *testing.T) {
@@ -236,9 +237,9 @@ func TestChangesWithNoChangeToTheOrder(t *testing.T) {
p.notify()
s, err := os.ReadFile("testdata/changes/changes.md")
assert.NoError(t, err)
new_line := "* [testdata/changes/alex](alex)\n"
newLine := "* [testdata/changes/alex](alex)\n"
// the change was already listed at the top, so just use the new title
assert.Equal(t, intro+d+new_line+other, string(s))
assert.Equal(t, intro+d+newLine+other, string(s))
// since the file has changed, a backup was necessary
assert.FileExists(t, "testdata/changes/changes.md~")
}

View File

@@ -2,13 +2,14 @@ package main
import (
"bytes"
"github.com/sergi/go-diff/diffmatchpatch"
"html"
"html/template"
"net/http"
"os"
"path/filepath"
"strings"
"github.com/sergi/go-diff/diffmatchpatch"
)
func diffHandler(w http.ResponseWriter, r *http.Request, name string) {
@@ -18,11 +19,11 @@ func diffHandler(w http.ResponseWriter, r *http.Request, name string) {
return
}
p.handleTitle(true)
p.renderHtml()
p.renderHTML()
renderTemplate(w, p.Dir(), "diff", p)
}
// Diff computes the diff for a page. At this point, renderHtml has already been called so the Name is escaped.
// Diff computes the diff for a page. At this point, renderHTML has already been called so the Name is escaped.
func (p *Page) Diff() template.HTML {
fp := filepath.FromSlash(p.Name)
a := fp + ".md~"

View File

@@ -1,11 +1,12 @@
package main
import (
"github.com/stretchr/testify/assert"
"net/http"
"os"
"testing"
"time"
"github.com/stretchr/testify/assert"
)
func TestDiff(t *testing.T) {

View File

@@ -41,5 +41,5 @@ func saveHandler(w http.ResponseWriter, r *http.Request, name string) {
return
}
}
http.Redirect(w, r, "/view/" + nameEscape(name), http.StatusFound)
http.Redirect(w, r, "/view/"+nameEscape(name), http.StatusFound)
}

View File

@@ -1,12 +1,13 @@
package main
import (
"github.com/stretchr/testify/assert"
"net/http"
"net/url"
"os"
"testing"
"time"
"github.com/stretchr/testify/assert"
)
func TestEditSave(t *testing.T) {

View File

@@ -4,13 +4,14 @@ import (
"context"
"flag"
"fmt"
"github.com/google/subcommands"
htmlTemplate "html/template"
"io"
"os"
"strings"
textTemplate "text/template"
"time"
"github.com/google/subcommands"
)
type exportCmd struct {
@@ -62,7 +63,7 @@ func exportCli(w io.Writer, templateName string, idx *indexStore) subcommands.Ex
return subcommands.ExitFailure
}
p.handleTitle(false)
p.renderHtml()
p.renderHTML()
fi, err := os.Stat(name + ".md")
if err != nil {
fmt.Fprintf(os.Stderr, "Stat %s: %s\n", name, err)
@@ -72,7 +73,7 @@ func exportCli(w io.Writer, templateName string, idx *indexStore) subcommands.Ex
it.Title = p.Title
it.Name = p.Name
it.Body = p.Body
it.Html = htmlTemplate.HTML(htmlTemplate.HTMLEscaper(p.Html))
it.HTML = htmlTemplate.HTML(htmlTemplate.HTMLEscaper(p.HTML))
it.Hashtags = p.Hashtags
items = append(items, it)
}

View File

@@ -2,11 +2,12 @@ package main
import (
"bytes"
"github.com/google/subcommands"
"github.com/stretchr/testify/assert"
"os"
"regexp"
"testing"
"github.com/google/subcommands"
"github.com/stretchr/testify/assert"
)
func TestExportCmd(t *testing.T) {
@@ -40,7 +41,7 @@ func TestExportCmdJsonFeed(t *testing.T) {
"title": "{{.Title}}",
"language": "{{.Language}}"
"date_modified": "{{.Date}}",
"content_html": "{{.Html}}",
"content_html": "{{.HTML}}",
"tags": [{{range .Hashtags}}"{{.}}",{{end}}""],
},{{end}}
{}

112
feed.go
View File

@@ -2,13 +2,22 @@ package main
import (
"bytes"
"github.com/gomarkdown/markdown"
"github.com/gomarkdown/markdown/ast"
"html/template"
"os"
"path"
"path/filepath"
"strconv"
"time"
"github.com/gomarkdown/markdown"
"github.com/gomarkdown/markdown/ast"
)
type dateSource int
const (
ModTime dateSource = iota
URL
)
// Item is a Page plus a Date.
@@ -34,19 +43,46 @@ type Feed struct {
// Items are based on the pages linked in list items starting with an asterisk ("*"). Links in
// list items starting with a minus ("-") are ignored!
Items []Item
// From is where the item number where the feed starts. It defaults to 0. Prev and From are the item numbers of
// The previous and the next page of the feed. N is the number of items per page. Next goes further into the
// past.
Prev, Next, From, N int
// When paging through the index or year pages, link to the next or previous years. NextYear goes further into
// the past (is smaller).
PrevYear, NextYear int
// Complete is set when there is no pagination.
Complete bool
}
// feed returns a RSS 2.0 feed for any page. The feed items it contains are the pages linked from in list items starting
// with an asterisk ("*").
func feed(p *Page, ti time.Time) *Feed {
// with an asterisk ("*"). The feed starts from a certain item and contains n items. If n is 0, the feed is complete
// (unpaginated). The
func feed(p *Page, ti time.Time, from, n int, source dateSource) *Feed {
feed := new(Feed)
feed.Name = p.Name
feed.Title = p.Title
feed.Date = ti.Format(time.RFC1123Z)
feed.From = from
feed.N = n
if n == 0 {
feed.Complete = true
} else if from > n {
feed.Prev = from - n
} else {
year, err := p.BlogYear()
if err == nil && p.ArchiveExists(year+1) {
feed.PrevYear = year + 1
}
}
to := from + n
parser, _ := wikiParser()
doc := markdown.Parse(p.Body, parser)
items := make([]Item, 0)
inListItem := false
i := 0
ast.WalkFunc(doc, func(node ast.Node, entering bool) ast.WalkStatus {
// set the flag if we're in a list item
listItem, ok := node.(*ast.ListItem)
@@ -58,33 +94,81 @@ func feed(p *Page, ti time.Time) *Feed {
if !inListItem || !entering {
return ast.GoToNext
}
// if we're in a link and it's local
// if we're in a link and it's not local
link, ok := node.(*ast.Link)
if !ok || bytes.Contains(link.Destination, []byte("//")) {
return ast.GoToNext
}
name := path.Join(p.Dir(), string(link.Destination))
fi, err := os.Stat(filepath.FromSlash(name) + ".md")
if err != nil {
// if we're too early or too late
i++
if i <= from {
return ast.GoToNext
}
if n > 0 && i > to {
// set if it's likely that more items exist
feed.Next = to
return ast.Terminate
}
// i counts links, not actual existing pages
name := path.Join(p.Dir(), string(link.Destination))
p2, err := loadPage(name)
if err != nil {
return ast.GoToNext
}
p2.handleTitle(false)
p2.renderHtml()
it := Item{Date: fi.ModTime().Format(time.RFC1123Z)}
p2.renderHTML()
date, err := p2.Date(source)
if err != nil {
return ast.GoToNext
}
it := Item{Date: date.Format(time.RFC1123Z)}
it.Title = p2.Title
it.Name = p2.Name
it.Html = template.HTML(template.HTMLEscaper(p2.Html))
it.HTML = template.HTML(template.HTMLEscaper(p2.HTML))
it.Hashtags = p2.Hashtags
items = append(items, it)
if len(items) >= 10 {
return ast.Terminate
}
return ast.GoToNext
})
// If there are no more "next" links but there is a next page, add it.
if feed.Next == 0 {
year, err := p.BlogYear()
if err == nil && p.ArchiveExists(year-1) {
feed.NextYear = year - 1
}
}
feed.Items = items
return feed
}
// Date returns the page's last modification date if the data source is ModTime. If the data source is URL, then the
// first 10 characters are parsed as an ISO date string and the time returned is for that date, 0:00, UTC.
func (p *Page) Date(source dateSource) (time.Time, error) {
if source == URL && p.IsBlog() {
name := path.Base(p.Name)
return time.Parse(time.DateOnly, name[0:10])
}
return p.ModTime()
}
// BLogYear returns the current year if the page name is "index". If the page name is a number such as "2026" then
// this is parsed as an integer and returned.
func (p *Page) BlogYear() (int, error) {
name := path.Base(p.Name)
if name == "index" {
return time.Now().Year(), nil
}
ui, err := strconv.ParseUint(name, 10, 16)
if err == nil {
return int(ui), nil
}
return 0, err
}
// ArchiveExists returns true if a page exists in the same directory as the current one with a page name matching
// the year given.
func (p *Page) ArchiveExists(year int) bool {
name := path.Join(p.Dir(), strconv.Itoa(year))
fp := filepath.FromSlash(name) + ".md"
_, err := os.Stat(fp)
return err == nil
}

View File

@@ -1,11 +1,17 @@
<rss xmlns:atom="http://www.w3.org/2005/Atom" version="2.0">
<rss xmlns:atom="http://www.w3.org/2005/Atom" version="2.0"
xmlns:fh="http://purl.org/syndication/history/1.0">
<channel>
<docs>http://blogs.law.harvard.edu/tech/rss</docs>
<title>{{.Title}}</title>
<link>https://example.org/</link>
<managingEditor>you@example.org (Your Name)</managingEditor>
<webMaster>you@example.org (Your Name)</webMaster>
<atom:link href="https://example.org/view/{{.Path}}.rss" rel="self" type="application/rss+xml"/>
<atom:link href="https://example.org/view/{{.Path}}.rss" rel="self" type="application/rss+xml"/>{{if .From}}
<atom:link href="https://example.org/view/{{.Path}}.rss?from={{.Prev}}&amp;n={{.N}}" rel="previous" type="application/rss+xml"/>{{end}}{{if .PrevYear}}
<atom:link href="https://example.org/view/{{.Dir}}{{.PrevYear}}.rss?n={{.N}}" rel="previous" type="application/rss+xml"/>{{end}}{{if .Next}}
<atom:link href="https://example.org/view/{{.Path}}.rss?from={{.Next}}&amp;n={{.N}}" rel="next" type="application/rss+xml"/>{{end}}{{if .NextYear}}
<atom:link href="https://example.org/view/{{.Dir}}{{.NextYear}}.rss?n={{.N}}" rel="next" type="application/rss+xml"/>{{end}}{{if .Complete}}
<fh:complete/>{{end}}
<description>This is the digital garden of Your Name.</description>
<image>
<url>https://example.org/view/logo.jpg</url>
@@ -17,7 +23,7 @@
<title>{{.Title}}</title>
<link>https://example.org/view/{{.Path}}</link>
<guid>https://example.org/view/{{.Path}}</guid>
<description>{{.Html}}</description>
<description>{{.HTML}}</description>
<pubDate>{{.Date}}</pubDate>
{{range .Hashtags}}
<category>{{.}}</category>

90
feed_cmd.go Normal file
View File

@@ -0,0 +1,90 @@
package main
import (
"context"
"flag"
"fmt"
"io"
"os"
"strings"
"time"
"github.com/google/subcommands"
)
type feedCmd struct {
}
func (*feedCmd) Name() string { return "feed" }
func (*feedCmd) Synopsis() string { return "render a page as feed" }
func (*feedCmd) Usage() string {
return `feed <page name> ...:
Render one or more pages as a single feed.
Use a single - to read Markdown from stdin.
`
}
func (cmd *feedCmd) SetFlags(f *flag.FlagSet) {
}
func (cmd *feedCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interface{}) subcommands.ExitStatus {
if len(f.Args()) == 0 {
fmt.Fprint(os.Stderr, cmd.Usage())
return subcommands.ExitFailure
}
return feedCli(os.Stdout, f.Args())
}
func feedCli(w io.Writer, args []string) subcommands.ExitStatus {
if len(args) == 1 && args[0] == "-" {
body, err := io.ReadAll(os.Stdin)
if err != nil {
fmt.Fprintf(os.Stderr, "Cannot read from stdin: %s\n", err)
return subcommands.ExitFailure
}
p := &Page{Name: "stdin", Body: body}
return p.printFeed(w, time.Now())
}
for _, name := range args {
if !strings.HasSuffix(name, ".md") {
fmt.Fprintf(os.Stderr, "%s does not end in '.md'\n", name)
return subcommands.ExitFailure
}
name = name[0 : len(name)-3]
p, err := loadPage(name)
p.handleTitle(false)
if err != nil {
fmt.Fprintf(os.Stderr, "Cannot load %s: %s\n", name, err)
return subcommands.ExitFailure
}
ti, _ := p.ModTime()
status := p.printFeed(w, ti)
if status != subcommands.ExitSuccess {
return status
}
}
return subcommands.ExitSuccess
}
// printFeed prints the complete feed for a page (unpaginated).
func (p *Page) printFeed(w io.Writer, ti time.Time) subcommands.ExitStatus {
f := feed(p, ti, 0, 0, URL)
if len(f.Items) == 0 {
fmt.Fprintf(os.Stderr, "Empty feed for %s\n", p.Name)
return subcommands.ExitFailure
}
_, err := w.Write([]byte(`<?xml version="1.0" encoding="UTF-8"?>`))
if err != nil {
fmt.Fprintf(os.Stderr, "Cannot write prefix: %s\n", err)
return subcommands.ExitFailure
}
loadTemplates()
templates.RLock()
defer templates.RUnlock()
err = templates.template["feed.html"].Execute(w, f)
if err != nil {
fmt.Fprintf(os.Stderr, "Cannot execute template: %s\n", err)
return subcommands.ExitFailure
}
return subcommands.ExitSuccess
}

26
feed_cmd_test.go Normal file
View File

@@ -0,0 +1,26 @@
package main
import (
"bytes"
"testing"
"github.com/google/subcommands"
"github.com/stretchr/testify/assert"
)
func TestFeedCmd(t *testing.T) {
cleanup(t, "testdata/complete")
p := &Page{Name: "testdata/complete/2025-12-01", Body: []byte("# 2025-12-01\n")}
p.save()
p = &Page{Name: "testdata/complete/index", Body: []byte(`# Index
* [2025-12-01](2025-12-01)
`)}
p.save()
b := new(bytes.Buffer)
s := feedCli(b, []string{"testdata/complete/index.md"})
assert.Equal(t, subcommands.ExitSuccess, s)
assert.Contains(t, b.String(), "<fh:complete/>")
assert.Contains(t, b.String(), "<title>2025-12-01</title>")
assert.Contains(t, b.String(), "<pubDate>Mon, 01 Dec 2025 00:00:00") // ignore timezone
}

View File

@@ -1,9 +1,12 @@
package main
import (
"github.com/stretchr/testify/assert"
"fmt"
"net/http"
"net/url"
"testing"
"github.com/stretchr/testify/assert"
)
func TestFeed(t *testing.T) {
@@ -19,7 +22,6 @@ func TestNoFeed(t *testing.T) {
func TestFeedItems(t *testing.T) {
cleanup(t, "testdata/feed")
index.load()
p1 := &Page{Name: "testdata/feed/cactus", Body: []byte(`# Cactus
Green head and white hair
@@ -53,3 +55,148 @@ Writing poems about plants.
assert.Contains(t, body, "<category>Succulent</category>")
assert.Contains(t, body, "<category>Palmtree</category>")
}
func TestFeedPagination(t *testing.T) {
cleanup(t, "testdata/pagination")
p := &Page{Name: "testdata/pagination/one", Body: []byte("# One\n")}
p.save()
p = &Page{Name: "testdata/pagination/two", Body: []byte("# Two\n")}
p.save()
p = &Page{Name: "testdata/pagination/three", Body: []byte("# Three\n")}
p.save()
p = &Page{Name: "testdata/pagination/four", Body: []byte("# Four\n")}
p.save()
p = &Page{Name: "testdata/pagination/five", Body: []byte("# Five\n")}
p.save()
p = &Page{Name: "testdata/pagination/six", Body: []byte("# Six\n")}
p.save()
p = &Page{Name: "testdata/pagination/seven", Body: []byte("# Seven\n")}
p.save()
p = &Page{Name: "testdata/pagination/eight", Body: []byte("# Eight\n")}
p.save()
p = &Page{Name: "testdata/pagination/nine", Body: []byte("# Nine\n")}
p.save()
p = &Page{Name: "testdata/pagination/ten", Body: []byte("# Ten\n")}
p.save()
p = &Page{Name: "testdata/pagination/index", Body: []byte(`# Index
* [one](one)
* [two](two)
* [three](three)
* [four](four)
* [five](five)
* [six](six)
* [seven](seven)
* [eight](eight)
* [nine](nine)
* [ten](ten)
`)}
p.save()
body := assert.HTTPBody(makeHandler(viewHandler, false, http.MethodGet), "GET", "/view/testdata/pagination/index.rss", nil)
assert.Contains(t, body, "<title>One</title>")
assert.Contains(t, body, "<title>Ten</title>")
assert.NotContains(t, body, `<atom:link href="https://example.org/view/testdata/pagination/index.rss?from=10&n=10" rel="next" type="application/rss+xml"/>`)
p = &Page{Name: "testdata/pagination/eleven", Body: []byte("# Eleven\n")}
p.save()
p = &Page{Name: "testdata/pagination/index", Body: []byte(`# Index
* [one](one)
* [two](two)
* [three](three)
* [four](four)
* [five](five)
* [six](six)
* [seven](seven)
* [eight](eight)
* [nine](nine)
* [ten](ten)
* [eleven](eleven)
`)}
p.save()
body = assert.HTTPBody(makeHandler(viewHandler, false, http.MethodGet), "GET", "/view/testdata/pagination/index.rss", nil)
assert.NotContains(t, body, "<title>Eleven</title>")
assert.Contains(t, body, `<atom:link href="https://example.org/view/testdata/pagination/index.rss?from=10&amp;n=10" rel="next" type="application/rss+xml"/>`)
params := url.Values{}
params.Set("n", "0")
body = assert.HTTPBody(makeHandler(viewHandler, false, http.MethodGet), "GET", "/view/testdata/pagination/index.rss", params)
assert.Contains(t, body, "<title>Eleven</title>")
assert.Contains(t, body, `<fh:complete/>`)
params = url.Values{}
params.Set("n", "3")
body = assert.HTTPBody(makeHandler(viewHandler, false, http.MethodGet), "GET", "/view/testdata/pagination/index.rss", params)
assert.Contains(t, body, "<title>One</title>")
assert.Contains(t, body, "<title>Three</title>")
assert.NotContains(t, body, "<title>Four</title>")
assert.Contains(t, body, `<atom:link href="https://example.org/view/testdata/pagination/index.rss?from=3&amp;n=3" rel="next" type="application/rss+xml"/>`)
params = url.Values{}
params.Set("from", "3")
params.Set("n", "3")
body = assert.HTTPBody(makeHandler(viewHandler, false, http.MethodGet), "GET", "/view/testdata/pagination/index.rss", params)
assert.NotContains(t, body, "<title>Three</title>")
assert.Contains(t, body, "<title>Four</title>")
assert.Contains(t, body, "<title>Six</title>")
assert.NotContains(t, body, "<title>Seven</title>")
assert.Contains(t, body, `<atom:link href="https://example.org/view/testdata/pagination/index.rss?from=0&amp;n=3" rel="previous" type="application/rss+xml"/>`)
assert.Contains(t, body, `<atom:link href="https://example.org/view/testdata/pagination/index.rss?from=6&amp;n=3" rel="next" type="application/rss+xml"/>`)
params = url.Values{}
params.Set("from", "2")
params.Set("n", "3")
body = assert.HTTPBody(makeHandler(viewHandler, false, http.MethodGet), "GET", "/view/testdata/pagination/index.rss", params)
assert.NotContains(t, body, "<title>Two</title>")
assert.Contains(t, body, "<title>Three</title>")
assert.Contains(t, body, "<title>Five</title>")
assert.NotContains(t, body, "<title>Six</title>")
assert.Contains(t, body, `<atom:link href="https://example.org/view/testdata/pagination/index.rss?from=0&amp;n=3" rel="previous" type="application/rss+xml"/>`)
assert.Contains(t, body, `<atom:link href="https://example.org/view/testdata/pagination/index.rss?from=5&amp;n=3" rel="next" type="application/rss+xml"/>`)
}
func TestFeedYearArchives(t *testing.T) {
cleanup(t, "testdata/archives")
p := &Page{Name: "testdata/archives/index", Body: []byte(`# Archives
my bent fingers hurt
keyboard rattling in the dark
but no child in sight
`)}
p.save()
body := assert.HTTPBody(makeHandler(viewHandler, false, http.MethodGet), "GET",
"/view/testdata/archives/index.rss", nil)
year, err := p.BlogYear()
assert.Greater(t, year, 0)
assert.NoError(t, err)
prevLink := fmt.Sprintf(`<atom:link href="https://example.org/view/testdata/archives/%d.rss?n=10" rel="previous" type="application/rss+xml"/>`, year+1)
nextLink := fmt.Sprintf(`<atom:link href="https://example.org/view/testdata/archives/%d.rss?n=10" rel="next" type="application/rss+xml"/>`, year-1)
assert.NotContains(t, body, prevLink)
assert.NotContains(t, body, nextLink)
p = &Page{Name: fmt.Sprintf("testdata/archives/%d", year-1), Body: []byte(`# Previously
I have seen it all
invasion and denial
and cold winter hearts
`)}
p.save()
body = assert.HTTPBody(makeHandler(viewHandler, false, http.MethodGet), "GET",
"/view/testdata/archives/index.rss", nil)
assert.NotContains(t, body, prevLink)
assert.Contains(t, body, nextLink)
p = &Page{Name: fmt.Sprintf("testdata/archives/%d", year+1), Body: []byte(`# Coming
A night of thunder
lightning, children, it's the war
of our New Year's Eve
`)}
p.save()
body = assert.HTTPBody(makeHandler(viewHandler, false, http.MethodGet), "GET",
"/view/testdata/archives/index.rss", nil)
assert.Contains(t, body, prevLink)
assert.Contains(t, body, nextLink)
}

2
go.mod
View File

@@ -1,4 +1,4 @@
module alexschroeder.ch/cgit/oddmu
module src.alexschroeder.ch/oddmu
go 1.22

View File

@@ -4,17 +4,18 @@ import (
"context"
"flag"
"fmt"
"github.com/google/subcommands"
"github.com/gomarkdown/markdown"
"github.com/gomarkdown/markdown/ast"
"github.com/hexops/gotextdiff"
"github.com/hexops/gotextdiff/myers"
"github.com/hexops/gotextdiff/span"
"io"
"os"
"regexp"
"sort"
"strings"
"github.com/gomarkdown/markdown"
"github.com/gomarkdown/markdown/ast"
"github.com/google/subcommands"
"github.com/hexops/gotextdiff"
"github.com/hexops/gotextdiff/myers"
"github.com/hexops/gotextdiff/span"
)
type hashtagsCmd struct {
@@ -86,7 +87,7 @@ func hashtagsUpdateCli(w io.Writer, dryRun bool) subcommands.ExitStatus {
continue
}
title, ok := namesMap[hashtag]
if (!ok) {
if !ok {
title = hashtagName(namesMap, hashtag, docids)
namesMap[hashtag] = title
}
@@ -133,7 +134,7 @@ func hashtagsUpdateCli(w io.Writer, dryRun bool) subcommands.ExitStatus {
}
fn := h.Name + ".md"
edits := myers.ComputeEdits(span.URIFromPath(fn), original, string(h.Body))
diff := fmt.Sprint(gotextdiff.ToUnified(fn + "~", fn, original, edits))
diff := fmt.Sprint(gotextdiff.ToUnified(fn+"~", fn, original, edits))
fmt.Fprint(w, diff)
} else {
err = h.save()
@@ -149,7 +150,7 @@ func hashtagsUpdateCli(w io.Writer, dryRun bool) subcommands.ExitStatus {
// Go through all the documents in the same directory and look for hashtag matches in the rendered HTML in order to
// determine the most likely capitalization.
func hashtagName (namesMap map[string]string, hashtag string, docids []docid) string {
func hashtagName(namesMap map[string]string, hashtag string, docids []docid) string {
candidate := make(map[string]int)
var mostPopular string
for _, docid := range docids {
@@ -166,8 +167,7 @@ func hashtagName (namesMap map[string]string, hashtag string, docids []docid) st
doc := markdown.Parse(p.Body, parser)
ast.WalkFunc(doc, func(node ast.Node, entering bool) ast.WalkStatus {
if entering {
switch v := node.(type) {
case *ast.Link:
if v, ok := node.(*ast.Link); ok {
for _, attr := range v.AdditionalAttributes {
if attr == `class="tag"` {
tagName := []byte("")
@@ -181,7 +181,7 @@ func hashtagName (namesMap map[string]string, hashtag string, docids []docid) st
if strings.EqualFold(hashtag, strings.ReplaceAll(tag, " ", "_")) {
_, ok := candidate[tag]
if ok {
candidate[tag] += 1
candidate[tag]++
} else {
candidate[tag] = 1
}

View File

@@ -2,9 +2,10 @@ package main
import (
"bytes"
"testing"
"github.com/google/subcommands"
"github.com/stretchr/testify/assert"
"testing"
)
func TestHashtagsCmd(t *testing.T) {

View File

@@ -4,10 +4,12 @@ import (
"context"
"flag"
"fmt"
"github.com/google/subcommands"
"html/template"
"io"
"os"
"strings"
"github.com/google/subcommands"
)
type htmlCmd struct {
@@ -40,20 +42,20 @@ func htmlCli(w io.Writer, template string, args []string) subcommands.ExitStatus
return subcommands.ExitFailure
}
p := &Page{Name: "stdin", Body: body}
return p.printHtml(w, template)
return p.printHTML(w, template)
}
for _, name := range args {
if !strings.HasSuffix(name, ".md") {
fmt.Fprintf(os.Stderr, "%s does not end in '.md'\n", name)
return subcommands.ExitFailure
}
name = name[0:len(name)-3]
name = name[0 : len(name)-3]
p, err := loadPage(name)
if err != nil {
fmt.Fprintf(os.Stderr, "Cannot load %s: %s\n", name, err)
return subcommands.ExitFailure
}
status := p.printHtml(w, template)
status := p.printHTML(w, template)
if status != subcommands.ExitSuccess {
return status
}
@@ -61,21 +63,28 @@ func htmlCli(w io.Writer, template string, args []string) subcommands.ExitStatus
return subcommands.ExitSuccess
}
func (p *Page) printHtml(w io.Writer, template string) subcommands.ExitStatus {
if len(template) > 0 {
t := template
loadTemplates()
p.handleTitle(true)
p.renderHtml()
err := templates.template[t].Execute(w, p)
func (p *Page) printHTML(w io.Writer, fn string) subcommands.ExitStatus {
if fn == "" {
// do not handle title
p.renderHTML()
_, err := fmt.Fprintln(w, p.HTML)
if err != nil {
fmt.Fprintf(os.Stderr, "Cannot execute %s template for %s: %s\n", t, p.Name, err)
fmt.Fprintf(os.Stderr, "Cannot write to stdout: %s\n", err)
return subcommands.ExitFailure
}
} else {
// do not handle title
p.renderHtml()
fmt.Fprintln(w, p.Html)
return subcommands.ExitSuccess
}
p.handleTitle(true)
p.renderHTML()
t, err := template.ParseFiles(fn)
if err != nil {
fmt.Fprintf(os.Stderr, "Cannot parse template %s for %s: %s\n", fn, p.Name, err)
return subcommands.ExitFailure
}
err = t.Execute(w, p)
if err != nil {
fmt.Fprintf(os.Stderr, "Cannot execute template %s for %s: %s\n", fn, p.Name, err)
return subcommands.ExitFailure
}
return subcommands.ExitSuccess
}

View File

@@ -2,9 +2,10 @@ package main
import (
"bytes"
"testing"
"github.com/google/subcommands"
"github.com/stretchr/testify/assert"
"testing"
)
func TestHtmlCmd(t *testing.T) {

View File

@@ -5,7 +5,6 @@
package main
import (
"golang.org/x/exp/constraints"
"html/template"
"io/fs"
"log"
@@ -13,6 +12,8 @@ import (
"sort"
"strings"
"sync"
"golang.org/x/exp/constraints"
)
type docid uint
@@ -23,15 +24,15 @@ type docid uint
// It depends on the fact that Title is always plain text.
type ImageData struct {
Title, Name string
Html template.HTML
HTML template.HTML
}
// indexStore controls access to the maps used for search. Make sure to lock and unlock as appropriate.
type indexStore struct {
sync.RWMutex
// next_id is the number of the next document added to the index
next_id docid
// nextID is the number of the next document added to the index
nextID docid
// index is an inverted index mapping tokens to document ids.
token map[string][]docid
@@ -54,7 +55,7 @@ func init() {
// reset the index. This assumes that the index is locked. It's useful for tests.
func (idx *indexStore) reset() {
idx.next_id = 0
idx.nextID = 0
idx.token = make(map[string][]docid)
idx.documents = make(map[docid]string)
idx.titles = make(map[string]string)
@@ -64,8 +65,8 @@ func (idx *indexStore) reset() {
// addDocument adds the text as a new document. This assumes that the index is locked!
// The hashtags (only!) are used as tokens. They are stored in lower case.
func (idx *indexStore) addDocument(text []byte) docid {
id := idx.next_id
idx.next_id++
id := idx.nextID
idx.nextID++
for _, token := range hashtags(text) {
token = strings.ToLower(token)
ids := idx.token[token]
@@ -147,9 +148,8 @@ func (idx *indexStore) walk(fp string, info fs.FileInfo, err error) error {
if fp != "." && strings.HasPrefix(filepath.Base(fp), ".") {
if info.IsDir() {
return filepath.SkipDir
} else {
return nil
}
return nil
}
// skipp all but page files
if !strings.HasSuffix(fp, ".md") {
@@ -238,11 +238,12 @@ func intersection[T constraints.Ordered](a []T, b []T) []T {
r := make([]T, 0, maxLen)
var i, j int
for i < len(a) && j < len(b) {
if a[i] < b[j] {
switch {
case a[i] < b[j]:
i++
} else if a[i] > b[j] {
case a[i] > b[j]:
j++
} else {
default:
r = append(r, a[i])
i++
j++

View File

@@ -1,3 +1,4 @@
# Welcome to Oddμ
Hello! 🙃

View File

@@ -1,9 +1,10 @@
package main
import (
"github.com/stretchr/testify/assert"
"strings"
"testing"
"github.com/stretchr/testify/assert"
)
func TestIndexAdd(t *testing.T) {

View File

@@ -2,9 +2,10 @@ package main
import (
"errors"
"github.com/pemistahl/lingua-go"
"os"
"strings"
"github.com/pemistahl/lingua-go"
)
// getLanguages returns the environment variable ODDMU_LANGUAGES or all languages.

View File

@@ -1,9 +1,10 @@
package main
import (
"github.com/stretchr/testify/assert"
"os"
"testing"
"github.com/stretchr/testify/assert"
)
func TestAllLanguage(t *testing.T) {

View File

@@ -4,10 +4,11 @@ import (
"context"
"flag"
"fmt"
"github.com/google/subcommands"
"io"
"os"
"strings"
"github.com/google/subcommands"
)
type linksCmd struct {
@@ -48,7 +49,7 @@ func linksCli(w io.Writer, args []string) subcommands.ExitStatus {
fmt.Fprintf(os.Stderr, "%s does not end in '.md'\n", name)
return subcommands.ExitFailure
}
name = name[0:len(name)-3]
name = name[0 : len(name)-3]
p, err := loadPage(name)
if err != nil {
fmt.Fprintf(w, "Loading %s: %s\n", name, err)

View File

@@ -2,9 +2,10 @@ package main
import (
"bytes"
"testing"
"github.com/google/subcommands"
"github.com/stretchr/testify/assert"
"testing"
)
func TestLinksCmd(t *testing.T) {

View File

@@ -4,11 +4,12 @@ import (
"context"
"flag"
"fmt"
"github.com/google/subcommands"
"io"
"os"
"path/filepath"
"strings"
"github.com/google/subcommands"
)
type listCmd struct {

View File

@@ -2,9 +2,10 @@ package main
import (
"bytes"
"testing"
"github.com/google/subcommands"
"github.com/stretchr/testify/assert"
"testing"
)
func TestListCmd(t *testing.T) {

View File

@@ -43,7 +43,7 @@ README.md: ../README.md
< $< > $@
upload: ${MD} README.md
rsync --itemize-changes --archive *.md sibirocobombus:alexschroeder.ch/wiki/oddmu/
rsync --itemize-changes --archive *.md ../README.md sibirocobombus:alexschroeder.ch/wiki/oddmu/
make clean
clean:

View File

@@ -40,7 +40,7 @@ ServerAdmin alex@alexschroeder.ch
<VirtualHost *:443>
ServerName transjovian.org
SSLEngine on
ProxyPassMatch "^/((view|preview|diff|edit|save|add|append|upload|drop|search|archive)/(.*))?$" \
ProxyPassMatch "^/((view|preview|diff|edit|save|add|append|upload|drop|search|archive)/(.*)|sitemap\.xml)?$" \
"http://localhost:8080/$1"
</VirtualHost>
```
@@ -106,13 +106,13 @@ ServerAdmin alex@alexschroeder.ch
ServerName transjovian.org
ProxyPassMatch "^/((view|diff|search|archive)/(.*))?$" \
"http://localhost:8080/$1"
RedirectMatch "^/((edit|save|add|append|upload|drop)/(.*))?$" \
RedirectMatch "^/((edit|save|add|append|upload|drop)/(.*)|sitemap\.xml)?$" \
"https://transjovian.org/$1"
</VirtualHost>
<VirtualHost *:443>
ServerName transjovian.org
SSLEngine on
ProxyPassMatch "^/((view|preview|diff|edit|save|add|append|upload|drop|search|archive)/(.*))?$" \
ProxyPassMatch "^/((view|preview|diff|edit|save|add|append|upload|drop|search|archive)/(.*)|sitemap\.xml)?$" \
"http://localhost:8080/$1"
</VirtualHost>
```
@@ -144,7 +144,7 @@ You probably want to serve some static files as well (see *Serve static files*).
In that case, you need to use the ProxyPassMatch directive.
```
ProxyPassMatch "^/((view|preview|diff|edit|save|add|append|upload|drop|search|archive)/(.*))?$" \
ProxyPassMatch "^/((view|preview|diff|edit|save|add|append|upload|drop|search|archive)/(.*)|sitemap\.xml)?$" \
"unix:/run/oddmu/oddmu.sock|http://localhost/$1"
```
@@ -159,7 +159,7 @@ A workaround is to add the redirect manually and drop the question-mark:
```
RedirectMatch "^/$" "/view/index"
ProxyPassMatch "^/((view|preview|diff|edit|save|add|append|upload|drop|search|archive)/(.*))$" \
ProxyPassMatch "^/((view|preview|diff|edit|save|add|append|upload|drop|search|archive)/(.*)|sitemap\.xml)$" \
"unix:/run/oddmu/oddmu.sock|http://localhost/$1"
```
@@ -213,8 +213,9 @@ The way Oddmu handles subdirectories is that all files and directories are
visible, except for "hidden" files and directories (whose name starts with a
period). Specifically, do not rely on Apache to hide locations in subdirectories
from public view. Search reveals the existence of these pages and produces an
extract, even if users cannot follow the links. Archive links pack all the
subdirectories, including locations you may have hidden from view using Apache.
extract, even if users cannot follow the links. The Sitemap lists all pages,
including subdirectories. Archive links pack all the subdirectories, including
locations you may have hidden from view using Apache.
If you to treat subdirectories as separate sites, you need to set the
environment variable ODDMU_FILTER to a regular expression matching the those

View File

@@ -5,7 +5,7 @@
.nh
.ad l
.\" Begin generated content:
.TH "ODDMU-EXPORT" "1" "2024-08-29"
.TH "ODDMU-EXPORT" "1" "2025-08-31"
.PP
.SH NAME
.PP
@@ -22,8 +22,8 @@ You probably want to redirect this into a file so that you can upload and import
it somewhere.\&
.PP
Note that this only handles pages (Markdown files).\& All other files (images,
PDFs, whatever else you uploaded) are not part of the feed and has to be
uploaded to the new platform in some other way.\&
PDFs, whatever else you uploaded) are not part of the feed and have to be
uploaded to the new platform using some other way.\&
.PP
The \fB-template\fR option specifies the template to use.\& If the template filename
ends in \fI.\&xml\fR, \fI.\&html\fR or \fI.\&rss\fR, it is assumed to contain XML and the optional

View File

@@ -15,8 +15,8 @@ You probably want to redirect this into a file so that you can upload and import
it somewhere.
Note that this only handles pages (Markdown files). All other files (images,
PDFs, whatever else you uploaded) are not part of the feed and has to be
uploaded to the new platform in some other way.
PDFs, whatever else you uploaded) are not part of the feed and have to be
uploaded to the new platform using some other way.
The *-template* option specifies the template to use. If the template filename
ends in _.xml_, _.html_ or _.rss_, it is assumed to contain XML and the optional

59
man/oddmu-feed.1 Normal file
View File

@@ -0,0 +1,59 @@
.\" Generated by scdoc 1.11.3
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "ODDMU-FEED" "1" "2025-12-31"
.PP
.SH NAME
.PP
oddmu-feed - render Oddmu page feed
.PP
.SH SYNOPSIS
.PP
\fBoddmu feed\fR \fIpage-name\fR .\&.\&.\&
.PP
.SH DESCRIPTION
.PP
The "feed" subcommand opens the given Markdown files and writes the resulting
RSS files without item limit (ordinarily, this default is 10 items per feed).\&
This uses the "feed.\&html" template.\& Use "-" as the page name if you want to read
Markdown from \fBstdin\fR.\&
.PP
Unlike the feeds generated by the \fBstatic\fR subcommand, the \fBfeed\fR command does
not limit the feed to the ten most recent items.\& Instead, all items on the list
are turned into feed items.\&
.PP
Furthermore, if the items on the list are blog posts (their page name starts
with an ISO date), then this ISO date is used for the last update date to the
page instead of the last modification time of the file.\& The idea, more or less,
is that this feed is an archive feed and that in this context the creation date
is more important than the last modification date.\&
.PP
.SH EXAMPLES
.PP
Generate "emacs.\&rss" from "emacs.\&md":
.PP
.nf
.RS 4
oddmu feed emacs\&.md
.fi
.RE
.PP
Alternatively:
.PP
.nf
.RS 4
oddmu feed - < emacs\&.md > emacs\&.rss
.fi
.RE
.PP
.SH SEE ALSO
.PP
\fIoddmu\fR(1), \fIoddmu-export\fR(1), \fIoddmu-static\fR(1)
.PP
.SH AUTHORS
.PP
Maintained by Alex Schroeder <alex@gnu.\&org>.\&

48
man/oddmu-feed.1.txt Normal file
View File

@@ -0,0 +1,48 @@
ODDMU-FEED(1)
# NAME
oddmu-feed - render Oddmu page feed
# SYNOPSIS
*oddmu feed* _page-name_ ...
# DESCRIPTION
The "feed" subcommand opens the given Markdown files and writes the resulting
RSS files without item limit (ordinarily, this default is 10 items per feed).
This uses the "feed.html" template. Use "-" as the page name if you want to read
Markdown from *stdin*.
Unlike the feeds generated by the *static* subcommand, the *feed* command does
not limit the feed to the ten most recent items. Instead, all items on the list
are turned into feed items.
Furthermore, if the items on the list are blog posts (their page name starts
with an ISO date), then this ISO date is used for the last update date to the
page instead of the last modification time of the file. The idea, more or less,
is that this feed is an archive feed and that in this context the creation date
is more important than the last modification date.
# EXAMPLES
Generate "emacs.rss" from "emacs.md":
```
oddmu feed emacs.md
```
Alternatively:
```
oddmu feed - < emacs.md > emacs.rss
```
# SEE ALSO
_oddmu_(1), _oddmu-export_(1), _oddmu-static_(1)
# AUTHORS
Maintained by Alex Schroeder <alex@gnu.org>.

View File

@@ -6,13 +6,13 @@ oddmu-filter - keeping subdirectories separate
# DESCRIPTION
There are actions such as searching and archiving that act on multiple pages,
not just a single page. These actions walk the directory tree, including all
subdirectories. In some cases, this is not desirable.
There are actions such as producing the sitemap, searching and archiving that
act on multiple pages, not just a single page. These actions walk the directory
tree, including all subdirectories. In some cases, this is not desirable.
Sometimes, subdirectories are separate sites, like the sites of other projects
or different people. Depending on how you think about it, you might not want to
include those "sites" in searches or archives of the whole site.
include those "sites" in searches, sitemaps or archives of the whole site.
Since directory tree actions always start in the directory the visitor is
currently looking at, directory tree actions starting in a "separate site"

View File

@@ -5,7 +5,7 @@
.nh
.ad l
.\" Begin generated content:
.TH "ODDMU-LIST" "1" "2024-08-29"
.TH "ODDMU-LIST" "1" "2025-08-31"
.PP
.SH NAME
.PP

View File

@@ -19,7 +19,7 @@ The site is defined in "/etc/nginx/sites-available/default", in the _server_
section. Add a new _location_ section after the existing _location_ section:
```
location ~ ^/(view|preview|diff|edit|save|add|append|upload|drop|search|archive)/ {
location ~ ^/(view|preview|diff|edit|save|add|append|upload|drop|search|sitemap|archive)/ {
proxy_pass http://localhost:8080;
}
```
@@ -81,7 +81,7 @@ server configuration. On a Debian system, that'd be in
"/etc/nginx/sites-available/default".
```
location ~ ^/(view|preview|diff|edit|save|add|append|upload|drop|search|archive)/ {
location ~ ^/(view|preview|diff|edit|save|add|append|upload|drop|search|sitemap|archive)/ {
proxy_pass http://unix:/run/oddmu/oddmu.sock:;
}
```

View File

@@ -1,11 +1,11 @@
.\" Generated by scdoc 1.11.3
.\" Generated by scdoc 1.11.4
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "ODDMU-RELEASES" "7" "2025-08-10"
.TH "ODDMU-RELEASES" "7" "2026-01-01"
.PP
.SH NAME
.PP
@@ -15,6 +15,85 @@ oddmu-releases - what'\&s new?\&
.PP
This page lists user-visible features and template changes to consider.\&
.PP
.SS 1.20 (unreleased)
.PP
Add -shrink and -glob options to the \fIstatic\fR subcommand.\&
.PP
Some tools were used to check the code (goimports, golint, gocritic).\&
Unfortunately, the resulting changes necessitates a change in the templates
("feed.\&html", "preview.\&html", "search.\&html", "static.\&html", "view.\&html"):
"{{.\&Html}}" must be changed to "{{.\&HTML}}".\& One way to do this:
.PP
.nf
.RS 4
find \&. -regex \&'\&.*/(feed|preview|search|static|view).html\&'
-exec sed -i~ \&'s/{{\&.Html}}/{{\&.HTML}}/g\&' \&'{}\&' \&'+\&'
.fi
.RE
.PP
The \fIfeed\fR subcommand uses the page URL to extract a pubDate instead of relying
on the file'\&s last modified time.\& For a complete feed (an archive), the last
modified time is less important.\&
.PP
The feed for the index page is paginated, like other feeds.\& But since it grows
faster than any of the feeds for hashtag pages, presumably, an extra features
was added: on the first and on the last page of the feed, a link to the next or
the previous year is added, if such a page exists.\& This works if at beginning of
every year, you move all the entries on to a dedicated year page.\& You need to
add the necessary links to the feed template ("feed.\&html").\& See
\fIoddmu-templates\fR(5) for more.\&
.PP
Example:
.PP
.nf
.RS 4
<rss xmlns:atom="http://www\&.w3\&.org/2005/Atom" version="2\&.0"
xmlns:fh="http://purl\&.org/syndication/history/1\&.0">
{{if \&.PrevYear}}
<atom:link href="https://example\&.org/view/{{\&.Dir}}{{\&.PrevYear}}\&.rss?n={{\&.N}}"
rel="previous" type="application/rss+xml"/>
{{end}}
{{if \&.NextYear}}
<atom:link href="https://example\&.org/view/{{\&.Dir}}{{\&.NextYear}}\&.rss?n={{\&.N}}"
rel="next" type="application/rss+xml"/>
{{end}}
.fi
.RE
.PP
.SS 1.19 (2025)
.PP
Add \fIfeed\fR subcommand.\& This produces a "complete" feed.\&
.PP
Add feed pagination for the \fIfeed\fR action.\& This produces a "paginated" feed.\&
.PP
See RFC 5005 for more information.\&
.PP
If you like the idea of feed pagination (not a given since that also helps bots
scrape your site!\&) you need to add the necessary links to the feed template
("feed.\&html").\& See \fIoddmu-templates\fR(5) for more.\&
.PP
Example, adding the feed history namespace:
.PP
.nf
.RS 4
<rss xmlns:atom="http://www\&.w3\&.org/2005/Atom" version="2\&.0"
xmlns:fh="http://purl\&.org/syndication/history/1\&.0">
{{if \&.From}}
<atom:link rel="previous" type="application/rss+xml"
href="https://example\&.org/view/{{\&.Path}}\&.rss?from={{\&.Prev}}&amp;n={{\&.N}}"/>
{{end}}
{{if \&.Next}}
<atom:link rel="next" type="application/rss+xml"
href="https://example\&.org/view/{{\&.Path}}\&.rss?from={{\&.Next}}&amp;n={{\&.N}}"/>
{{end}}
{{if \&.Complete}}<fh:complete/>{{end}}
.fi
.RE
.PP
.SS 1.18 (2025)
.PP
The \fIhashtags\fR gained the option of checking and fixing the hashtag pages by

View File

@@ -8,6 +8,79 @@ oddmu-releases - what's new?
This page lists user-visible features and template changes to consider.
## 1.20 (unreleased)
Add -shrink and -glob options to the _static_ subcommand.
Some tools were used to check the code (goimports, golint, gocritic).
Unfortunately, the resulting changes necessitates a change in the templates
("feed.html", "preview.html", "search.html", "static.html", "view.html"):
"{{.Html}}" must be changed to "{{.HTML}}". One way to do this:
```
find . -regex '.*/\(feed\|preview\|search\|static\|view\)\.html' \
-exec sed -i~ 's/{{.Html}}/{{.HTML}}/g' '{}' '+'
```
The _feed_ subcommand uses the page URL to extract a pubDate instead of relying
on the file's last modified time. For a complete feed (an archive), the last
modified time is less important.
The feed for the index page is paginated, like other feeds. But since it grows
faster than any of the feeds for hashtag pages, presumably, an extra features
was added: on the first and on the last page of the feed, a link to the next or
the previous year is added, if such a page exists. This works if at beginning of
every year, you move all the entries on to a dedicated year page. You need to
add the necessary links to the feed template ("feed.html"). See
_oddmu-templates_(5) for more.
Example:
```
<rss xmlns:atom="http://www.w3.org/2005/Atom" version="2.0"
xmlns:fh="http://purl.org/syndication/history/1.0">
{{if .PrevYear}}
<atom:link href="https://example.org/view/{{.Dir}}{{.PrevYear}}.rss?n={{.N}}"
rel="previous" type="application/rss+xml"/>
{{end}}
{{if .NextYear}}
<atom:link href="https://example.org/view/{{.Dir}}{{.NextYear}}.rss?n={{.N}}"
rel="next" type="application/rss+xml"/>
{{end}}
```
## 1.19 (2025)
Add _feed_ subcommand. This produces a "complete" feed.
Add feed pagination for the _feed_ action. This produces a "paginated" feed.
See RFC 5005 for more information.
If you like the idea of feed pagination (not a given since that also helps bots
scrape your site!) you need to add the necessary links to the feed template
("feed.html"). See _oddmu-templates_(5) for more.
Example, adding the feed history namespace:
```
<rss xmlns:atom="http://www.w3.org/2005/Atom" version="2.0"
xmlns:fh="http://purl.org/syndication/history/1.0">
{{if .From}}
<atom:link rel="previous" type="application/rss+xml"
href="https://example.org/view/{{.Path}}.rss?from={{.Prev}}&amp;n={{.N}}"/>
{{end}}
{{if .Next}}
<atom:link rel="next" type="application/rss+xml"
href="https://example.org/view/{{.Path}}.rss?from={{.Next}}&amp;n={{.N}}"/>
{{end}}
{{if .Complete}}<fh:complete/>{{end}}
```
## 1.18 (2025)
The _hashtags_ gained the option of checking and fixing the hashtag pages by

38
man/oddmu-sitemap.1.txt Normal file
View File

@@ -0,0 +1,38 @@
ODDMU-SITEMAP(1)
# NAME
oddmu-sitemap - print static sitemap.xml
# SYNOPSIS
*oddmu sitemap* [-base URL]
# DESCRIPTION
The "sitemap" subcommand prints the list of all pages in Sitemap format. Oddmu
already serves the sitemap at the URL "/sitemap.xml" but if you'd prefer to
provide a static file, use this command and redirect the output to a file called
"sitemap.xml" in your document root at regular intervals.
If you do this, don't proxy the "/sitemap" URL in the web server configuration.
Your "robots.txt" file, if you have one, should point at the sitemap you
provide.
# OPTIONS
*-base* _URL_
The base URL is something like "https://example.org/view/".
*-filter* _regexp_
A regular expression matching the pages to exclude from the sitemap.
This emulates the effect of the ODDMU_FILTER environment variable.
# SEE ALSO
_oddmu_(1), _oddmu-filter_(7), _oddmu-apache_(1), _oddmu-nginx_(1),
https://www.sitemaps.org/
# AUTHORS
Maintained by Alex Schroeder <alex@gnu.org>.

View File

@@ -1,11 +1,11 @@
.\" Generated by scdoc 1.11.3
.\" Generated by scdoc 1.11.4
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "ODDMU-STATIC" "1" "2024-08-29"
.TH "ODDMU-STATIC" "1" "2025-12-05"
.PP
.SH NAME
.PP
@@ -13,7 +13,7 @@ oddmu-static - create a static copy of the site
.PP
.SH SYNOPSIS
.PP
\fBoddmu static\fR \fIdir-name\fR
\fBoddmu static\fR [\fB\fR-jobs\fB\fR \fIn\fR] [\fB\fR-glob\fB\fR \fIpattern\fR] [\fB\fR-shrink\fB\fR] \fIdir-name\fR
.PP
.SH DESCRIPTION
.PP
@@ -28,22 +28,22 @@ pages get ".\&html" appended.\&
If a page has a name case-insensitively matching a hashtag, a feed file is
generated (ending with ".\&rss") if any suitable links are found.\& A suitable link
for a feed item must appear in a bullet list item using an asterisk ("*").\& If
no feed items are found, no feed is written.\&
no feed items are found, no feed is written.\& The feed is limited to the ten most
recent items.\&
.PP
Hidden files and directories (starting with a ".\&") and backup files (ending with
a "~") are skipped.\&
a "\(ti") are skipped.\&
.PP
All other files are \fIhard linked\fR.\& This is done to save space: on a typical blog
the images take a lot more space than the text.\& On my blog in 2023 I had 2.\&62
GiB of JPG files and 0.\&02 GiB of Markdown files.\& There is no point in copying
all those images, most of the time.\&
.PP
Note, however: Hard links cannot span filesystems.\& A hard link is just an extra
name for the same file.\& This is why the destination directory for the static
site has to be on same filesystem as the current directory, if it contains any
other files besides Markdown files.\&
As hard links cannot span filesystems, all other files are \fIcopied\fR if the
destination directory for the static site is not on same filesystem as the
current directory.\&
.PP
Furthermore, in-place editing changes the file for all names.\& Avoid editing the
Note that in-place editing changes the file for all names.\& Avoid editing the
hard-linked files (anything that'\&s not a HTML file) in the destination
directory, just to be on the safe side.\& Usually you should be fine, as an editor
moves the file that'\&s being edited to a backup file and creates a new file.\& But
@@ -51,6 +51,35 @@ then again, who knows.\& A SQLite file, for example, would change in-place, and
therefore making changes to it in the destination directory would change the
original, too.\&
.PP
.SH OPTIONS
.PP
\fB\fR-jobs\fB\fR \fIn\fR
.RS 4
By default, two jobs are used to process the files.\& If your machine has
more cores, you can increase the number of jobs.\&
.PP
.RE
\fB\fR-glob\fB\fR \fIpattern\fR
.RS 4
By default, all files are used for the static export.\& You can limit the
files used by providing a shell file name pattern.\& A "*" matches any
number of characters; a "?\&" matches exactly one character; "[a-z]"
matches a character listed, including ranges; "[\(haa-z]" matches a
character not listed, including ranges; "\e" a backslash escapes the
following character.\& You must use quotes around the pattern if you are
using a shell as the shell would otherwise expand the pattern, resulting
in the error "Exactly one target directory is required".\&
.PP
.PP
.RE
\fB\fR-shrink\fB\fR
.RS 4
By default, images are linked or copied.\& With this option, JPEG, PNG and
WebP files are scaled down if more than 800 pixels wide and the quality
is set to 10% for JPEG and WebP files.\& This is \fIvery bad quality\fR but
the result is that these image files are very small.\&
.PP
.RE
.SH EXAMPLES
.PP
Generate a static copy of the site, but only loading language detection for
@@ -89,7 +118,11 @@ speed language determination up.\&
.PP
.SH SEE ALSO
.PP
\fIoddmu\fR(1), \fIoddmu-templates\fR(5)
See \fIoddmu\fR(1) and \fIoddmu-templates\fR(5) for general information.\&
.PP
See \fIoddmu-html\fR(1) for a subcommand that converts individual pages file to HTML
and see \fIoddmu-feed\fR(1) for a subcommand that generates feeds for individual
files.\&
.PP
.SH AUTHORS
.PP

View File

@@ -6,7 +6,7 @@ oddmu-static - create a static copy of the site
# SYNOPSIS
*oddmu static* _dir-name_
*oddmu static* [**-jobs** _n_] [**-glob** _pattern_] [**-shrink**] _dir-name_
# DESCRIPTION
@@ -21,7 +21,8 @@ pages get ".html" appended.
If a page has a name case-insensitively matching a hashtag, a feed file is
generated (ending with ".rss") if any suitable links are found. A suitable link
for a feed item must appear in a bullet list item using an asterisk ("\*"). If
no feed items are found, no feed is written.
no feed items are found, no feed is written. The feed is limited to the ten most
recent items.
Hidden files and directories (starting with a ".") and backup files (ending with
a "~") are skipped.
@@ -31,12 +32,11 @@ the images take a lot more space than the text. On my blog in 2023 I had 2.62
GiB of JPG files and 0.02 GiB of Markdown files. There is no point in copying
all those images, most of the time.
Note, however: Hard links cannot span filesystems. A hard link is just an extra
name for the same file. This is why the destination directory for the static
site has to be on same filesystem as the current directory, if it contains any
other files besides Markdown files.
As hard links cannot span filesystems, all other files are _copied_ if the
destination directory for the static site is not on same filesystem as the
current directory.
Furthermore, in-place editing changes the file for all names. Avoid editing the
Note that in-place editing changes the file for all names. Avoid editing the
hard-linked files (anything that's not a HTML file) in the destination
directory, just to be on the safe side. Usually you should be fine, as an editor
moves the file that's being edited to a backup file and creates a new file. But
@@ -44,6 +44,29 @@ then again, who knows. A SQLite file, for example, would change in-place, and
therefore making changes to it in the destination directory would change the
original, too.
# OPTIONS
**-jobs** _n_
By default, two jobs are used to process the files. If your machine has
more cores, you can increase the number of jobs.
**-glob** _pattern_
By default, all files are used for the static export. You can limit the
files used by providing a shell file name pattern. A "\*" matches any
number of characters; a "?" matches exactly one character; "[a-z]"
matches a character listed, including ranges; "[^a-z]" matches a
character not listed, including ranges; "\\" a backslash escapes the
following character. You must use quotes around the pattern if you are
using a shell as the shell would otherwise expand the pattern, resulting
in the error "Exactly one target directory is required".
**-shrink**
By default, images are linked or copied. With this option, JPEG, PNG and
WebP files are scaled down if more than 800 pixels wide and the quality
is set to 10% for JPEG and WebP files. This is _very bad quality_ but
the result is that these image files are very small.
# EXAMPLES
Generate a static copy of the site, but only loading language detection for
@@ -80,7 +103,11 @@ speed language determination up.
# SEE ALSO
_oddmu_(1), _oddmu-templates_(5)
See _oddmu_(1) and _oddmu-templates_(5) for general information.
See _oddmu-html_(1) for a subcommand that converts individual pages file to HTML
and see _oddmu-feed_(1) for a subcommand that generates feeds for individual
files.
# AUTHORS

View File

@@ -1,11 +1,11 @@
.\" Generated by scdoc 1.11.3
.\" Generated by scdoc 1.11.4
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "ODDMU-TEMPLATES" "5" "2025-04-26" "File Formats Manual"
.TH "ODDMU-TEMPLATES" "5" "2026-01-01" "File Formats Manual"
.PP
.SH NAME
.PP
@@ -132,6 +132,46 @@ An item is a page plus a date.\& All the properties of a page can be used (see
.PP
\fI{{.\&Date}}\fR is the date of the last update to the page, in RFC 822 format.\&
.PP
In order to paginate feeds, the following attributes are also available in the
feed:
.PP
\fI{{.\&From}}\fR is the item number where the feed starts.\& The first page starts at
0.\& This can be passed to Oddmu via the query parameter \fIfrom\fR.\&
.PP
\fI{{.\&N}}\fR is the number items per page.\& The default is 10.\& This can be passed to
Oddmu via the query parameter \fIn\fR.\& If this is set to 0, the feed is not
paginated.\&
.PP
\fI{{.\&Complete}}\fR is a boolean that is true if the feed is not paginated.\& Such a
feed cannot have a previous or next page.\&
.PP
\fI{{.\&Prev}}\fR is the item number where the previous page of the feed starts.\& On
the first page, it'\&s value is 0 instead of -10.\& You need to test if \fI{{.\&From}}\fR
is non-zero (in which case this is not the first page) before using \fI{{.\&Prev}}\fR.\&
.PP
\fI{{.\&Next}}\fR is the item number where the next feed starts, if there are any
items left.\& If there are none, it'\&s value is 0.\&
.PP
\fI{{.\&PrevYear}}\fR is the year for the previous yearly archive.\& This is added on
the index page or on year pages.\& Year pages are pages whose name is just a
number (presumably a year).\& The property is only set on the first page of the
feed, if the previous year page exists.\& The previous year is one higher than the
year currently shown (if on a year page) or the current year (if looking at the
index), since the feed goes backwards in time as new entries appear at the top.\&
When looking at the page "2024" the previous page is "2025".\& Strangely enough,
if the current year is 2026 but a page "2027" already exists, and the feed for
the index page is generated, then "2027" (in the future) is the previous page.\&
If the current year is 2026, the feed of the index page points to "2025" as the
next year, if it exists.\& When the feed for "2025" is generated, however, the
previous year is not set, assuming that the "2026" page does not yet exist and
it is strange to consider the index page "the previous year" of "2025" in 2026.\&
This might change in the future.\& If it isn'\&t set, it'\&s value is 0.\&
.PP
\fI{{.\&NextYear}}\fR is the year for the next yearly archive.\& See above for an
explanation.\& The next year is one lower than the year currently shown (if on a
year page) or the current year (if looking at the index).\& If it isn'\&t set, it'\&s
value is 0.\&
.PP
.SS List
.PP
The list contains a directory name and an array of files.\&

View File

@@ -18,9 +18,9 @@ placeholders.
- _diff.html_ uses a _page_
- _edit.html_ uses a _page_
- _feed.html_ uses a _feed_
- _list.html_ uses a _list_
- _preview.html_ uses a _page_
- _search.html_ uses a _search_
- _sitemap.html_ uses a _sitemap_
- _static.html_ uses a _page_
- _upload.html_ uses an _upload_
- _view.html_ uses a _page_
@@ -106,31 +106,45 @@ An item is a page plus a date. All the properties of a page can be used (see
_{{.Date}}_ is the date of the last update to the page, in RFC 822 format.
## List
In order to paginate feeds, the following attributes are also available in the
feed:
The list contains a directory name and an array of files.
_{{.From}}_ is the item number where the feed starts. The first page starts at
0. This can be passed to Oddmu via the query parameter _from_.
_{{.Dir}}_ is the directory name that is being listed, percent-encoded.
_{{.N}}_ is the number items per page. The default is 10. This can be passed to
Oddmu via the query parameter _n_. If this is set to 0, the feed is not
paginated.
_{{.Files}}_ is the array of files. To refer to them, you need to use a _{{range
.Files}}_ … _{{end}}_ construct.
_{{.Complete}}_ is a boolean that is true if the feed is not paginated. Such a
feed cannot have a previous or next page.
Each file has the following attributes:
_{{.Prev}}_ is the item number where the previous page of the feed starts. On
the first page, it's value is 0 instead of -10. You need to test if _{{.From}}_
is non-zero (in which case this is not the first page) before using _{{.Prev}}_.
_{{.Name}}_ is the filename. The ".md" suffix for Markdown files is part of the
name (unlike page names).
_{{.Next}}_ is the item number where the next feed starts, if there are any
items left. If there are none, it's value is 0.
_{{.Path}}_ is the page name, percent-encoded.
_{{.PrevYear}}_ is the year for the previous yearly archive. This is added on
the index page or on year pages. Year pages are pages whose name is just a
number (presumably a year). The property is only set on the first page of the
feed, if the previous year page exists. The previous year is one higher than the
year currently shown (if on a year page) or the current year (if looking at the
index), since the feed goes backwards in time as new entries appear at the top.
When looking at the page "2024" the previous page is "2025". Strangely enough,
if the current year is 2026 but a page "2027" already exists, and the feed for
the index page is generated, then "2027" (in the future) is the previous page.
If the current year is 2026, the feed of the index page points to "2025" as the
next year, if it exists. When the feed for "2025" is generated, however, the
previous year is not set, assuming that the "2026" page does not yet exist and
it is strange to consider the index page "the previous year" of "2025" in 2026.
This might change in the future. If it isn't set, it's value is 0.
_{{.Title}}_ is the page title, if the file in question is a Markdown file.
_{{.IsDir}}_ is a boolean used to indicate that this file is a directory.
_{{.IsUp}}_ is a boolean used to indicate the entry for the parent directory
(the first file in the array, unless the directory being listed is the top
directory). The filename of this file is "..".
_{{.Date}}_ is the last modification date of the file.
_{{.NextYear}}_ is the year for the next yearly archive. See above for an
explanation. The next year is one lower than the year currently shown (if on a
year page) or the current year (if looking at the index). If it isn't set, it's
value is 0.
## Search
@@ -170,6 +184,16 @@ _{{.Name}}_ is the file name for use in URLs.
_{{.Html}}_ the image alt-text with a bold tag used to highlight the first
search term that matched.
## Sitemap
The sitemap contains a list of URLs, each with its location:
_{{.URL}}_ is the list of URLs.
Each URL has the following attributes:
_{{.Loc}}_ with the actual page URL.
## Upload
_{{.Dir}}_ is the directory where the uploaded file ends up, based on the URL

View File

@@ -1,419 +0,0 @@
.\" Generated by scdoc 1.11.3
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "ODDMU" "1" "2025-08-09"
.PP
.SH NAME
.PP
oddmu - a wiki server
.PP
Oddmu is sometimes written Oddμ because μ is the letter mu.\&
.PP
.SH SYNOPSIS
.PP
\fBoddmu\fR
.PP
\fBoddmu\fR \fIsubcommand\fR [\fIarguments\fR.\&.\&.\&]
.PP
.SH DESCRIPTION
.PP
Oddmu can be used as a static site generator, turning Markdown files into HTML
files, or it can be used as a public or a private wiki server.\& If it runs as a
public wiki server, a regular webserver should be used as reverse proxy.\&
.PP
Run Oddmu without any arguments to serve the current working directory as a wiki
on port 8080.\& Point your browser to http://localhost:8080/ to use it.\& This
redirects you to http://localhost:8080/view/index the first page you'\&ll
create, most likely.\&
.PP
See \fIoddmu\fR(5) for details about the page formatting.\&
.PP
If you request a page that doesn'\&t exist, Oddmu tries to find a matching
Markdown file by appending the extension ".\&md" to the page name.\& In the example
above, the page name requested is "index" and the file name Oddmu tries to read
is "index.\&md".\& If no such file exists, Oddmu offers you to create the page.\&
.PP
If your files don'\&t provide their own title ("# title"), the file name (without
".\&md") is used for the page title.\&
.PP
Every file can be viewed as feed by using the extension ".\&rss".\& The
feed items are based on links in bullet lists using the asterix
("*").\&
.PP
Subdirectories are created as necessary.\&
.PP
The wiki knows the following actions for a given page name and (optional)
directory:
.PP
.PD 0
.IP \(bu 4
\fI/\fR redirects to /view/index
.IP \(bu 4
\fI/view/dir/\fR redirects to /view/dir/index
.IP \(bu 4
\fI/view/dir/name\fR shows a page
.IP \(bu 4
\fI/view/dir/name.\&md\fR shows the source text of a page
.IP \(bu 4
\fI/view/dir/name.\&rss\fR shows the RSS feed for the pages linked
.IP \(bu 4
\fI/diff/dir/name\fR shows the last change to a page
.IP \(bu 4
\fI/edit/dir/name\fR shows a form to edit a page
.IP \(bu 4
\fI/preview/dir/name\fR shows a preview of a page edit and the form to edit it
.IP \(bu 4
\fI/save/dir/name\fR saves an edit
.IP \(bu 4
\fI/add/dir/name\fR shows a form to add to a page
.IP \(bu 4
\fI/append/dir/name\fR appends an addition to a page
.IP \(bu 4
\fI/upload/dir/name\fR shows a form to upload a file
.IP \(bu 4
\fI/drop/dir/name\fR saves an upload
.IP \(bu 4
\fI/search/dir/?\&q=term\fR to search for a term
.IP \(bu 4
\fI/archive/dir/name.\&zip\fR to download a zip file of a directory
.PD
.PP
When calling the \fIsave\fR and \fIappend\fR action, the page name is taken from the URL
path and the page content is taken from the \fIbody\fR form parameter.\& To
illustrate, here'\&s how to edit the "welcome" page using \fIcurl\fR:
.PP
.nf
.RS 4
curl --form body="Did you bring a towel?"
http://localhost:8080/save/welcome
.fi
.RE
.PP
When calling the \fIdrop\fR action, the query parameters used are \fIname\fR for the
target filename and \fIfile\fR for the file to upload.\& If the query parameter
\fImaxwidth\fR is set, an attempt is made to decode and resize the image.\& JPG, PNG,
WEBP and HEIC files can be decoded.\& Only JPG and PNG files can be encoded,
however.\& If the target name ends in \fI.\&jpg\fR, the \fIquality\fR query parameter is
also taken into account.\& To upload some thumbnails:
.PP
.nf
.RS 4
for f in *\&.jpg; do
curl --form name="$f" --form file=@"$f" --form maxwidth=100
http://localhost:8080/drop/
done
.fi
.RE
.PP
When calling the \fIsearch\fR action, the search terms are taken from the query
parameter \fIq\fR.\&
.PP
.nf
.RS 4
curl \&'http://localhost:8080/search/?q=towel\&'
.fi
.RE
.PP
The page name to act upon is optionally taken from the query parameter \fIid\fR.\& In
this case, the directory must also be part of the query parameter and not of the
URL path.\&
.PP
.nf
.RS 4
curl \&'http://localhost:8080/view/?id=man/oddmu\&.1\&.txt\&'
.fi
.RE
.PP
The base name for the \fIarchive\fR action is used by the browser to save the
downloaded file.\& For Oddmu, only the directory is important.\& The following zips
the \fIman\fR directory and saves it as \fIman.\&zip\fR.\&
.PP
.nf
.RS 4
curl --remote-name \&'http://localhost:8080/archive/man/man\&.zip
.fi
.RE
.PP
.SH CONFIGURATION
.PP
The template files are the HTML files in the working directory.\& Please change
these templates!\&
.PP
The first change you should make is to replace the name and email address in the
footer of \fIview.\&html\fR.\& Look for "Your Name" and "example.\&org".\&
.PP
The second change you should make is to replace the name, email address and
domain name in "feed.\&html".\& Look for "Your Name" and "example.\&org".\&
.PP
See \fIoddmu-templates\fR(5) for more.\&
.PP
.SH ENVIRONMENT
.PP
You can change the port served by setting the ODDMU_PORT environment variable.\&
.PP
You can change the address served by setting the ODDMU_ADDRESS environment
variable to either an IPv4 address or an IPv6 address.\& If ODDMU_ADDRESS is
unset, then the program listens on all available unicast addresses, both IPv4
and IPv6.\& Here are a few example addresses:
.PP
.nf
.RS 4
ODDMU_ADDRESS=127\&.0\&.0\&.1 # The loopback IPv4 address\&.
ODDMU_ADDRESS=2001:db8::3:1 # An IPv6 address\&.
.fi
.RE
.PP
See the Socket Activation section for an alternative method of listening which
supports Unix-domain sockets.\&
.PP
In order to limit language-detection to the languages you actually use, set the
environment variable ODDMU_LANGUAGES to a comma-separated list of ISO 639-1
codes, e.\&g.\& "en" or "en,de,fr,pt".\&
.PP
You can enable webfinger to link fediverse accounts to their correct profile
pages by setting ODDMU_WEBFINGER to "1".\& See \fIoddmu\fR(5).\&
.PP
If you use secret subdirectories, you cannot rely on the web server to hide
those pages because some actions such as searching and archiving include
subdirectories.\& They act upon a whole tree of pages, not just a single page.\& The
ODDMU_FILTER can be used to exclude subdirectories from such tree actions.\& See
\fIoddmu-filter\fR(7) and \fIoddmu-apache\fR(5).\&
.PP
.SH Socket Activation
.PP
Instead of specifying ODDMU_ADDRESS or ODDMU_PORT, you can start the service
through socket activation.\& The advantage of this method is that you can use a
Unix-domain socket instead of a TCP socket, and the permissions and ownership of
the socket are set before the program starts.\& See \fIoddmu.\&service\fR(5),
\fIoddmu-apache\fR(5) and \fIoddmu-nginx\fR(5) for an example of how to use socket
activation with a Unix-domain socket under systemd and Apache.\&
.PP
.SH SECURITY
.PP
If the machine you are running Oddmu on is accessible from the Internet, you
must secure your installation.\& The best way to do this is use a regular web
server as a reverse proxy.\& See \fIoddmu-apache\fR(5) and \fIoddmu-nginx\fR(5) for
example configurations.\&
.PP
Oddmu assumes that all the users that can edit pages or upload files are trusted
users and therefore their content is trusted.\& Oddmu does not perform HTML
sanitization!\&
.PP
For an extra dose of security, consider using a Unix-domain socket.\&
.PP
.SH OPTIONS
.PP
Oddmu can be run on the command-line using various subcommands.\&
.PP
.PD 0
.IP \(bu 4
to generate the HTML for a single page, see \fIoddmu-html\fR(1)
.IP \(bu 4
to generate the HTML for the entire site, using Oddmu as a static site
generator, see \fIoddmu-static\fR(1)
.IP \(bu 4
to export the HTML for the entire site in one big feed, see \fIoddmu-export\fR(1)
.IP \(bu 4
to emulate a search of the files, see \fIoddmu-search\fR(1); to understand how the
search engine indexes pages and how it sorts and scores results, see
\fIoddmu-search\fR(7)
.IP \(bu 4
to search a regular expression and replace it across all files, see
\fIoddmu-replace\fR(1)
.IP \(bu 4
to learn what the most popular hashtags are, see \fIoddmu-hashtags\fR(1)
.IP \(bu 4
to print a table of contents (TOC) for a page, see \fIoddmu-toc\fR(1)
.IP \(bu 4
to list the outgoing links for a page, see \fIoddmu-links\fR(1)
.IP \(bu 4
to find missing pages (local links that go nowhere), see \fIoddmu-missing\fR(1)
.IP \(bu 4
to list all the pages with name and title, see \fIoddmu-list\fR(1)
.IP \(bu 4
to add links to changes, index and hashtag pages to pages you created locally,
see \fIoddmu-notify\fR(1)
.IP \(bu 4
to display build information, see \fIoddmu-version\fR(1)
.PD
.PP
.SH EXAMPLES
.PP
When saving a page, the page name is take from the URL and the page content is
taken from the "body" form parameter.\& To illustrate, here'\&s how to edit a page
using \fIcurl\fR(1):
.PP
.nf
.RS 4
curl --form body="Did you bring a towel?"
http://localhost:8080/save/welcome
.fi
.RE
.PP
To compute the space used by your setup, use regular tools:
.PP
.nf
.RS 4
du --exclude=\&'*/.*\&' --exclude \&'*~\&' --block-size=M
.fi
.RE
.PP
.SH DESIGN
.PP
This is a minimal wiki.\& There is no version history.\& It'\&s well suited as a
\fIsecondary\fR medium: collaboration and conversation happens elsewhere, in chat,
on social media.\& The wiki serves as the text repository that results from these
discussions.\&
.PP
The idea is that the webserver handles as many tasks as possible.\& It logs
requests, does rate limiting, handles encryption, gets the certificates, and so
on.\& The web server acts as a reverse proxy and the wiki ends up being a content
management system with almost no structure or endless malleability, depending
on your point of view.\& See \fIoddmu-apache\fR(5).\&
.PP
.SH NOTES
.PP
Page names are filenames with ".\&md" appended.\& If your filesystem cannot handle
it, it can'\&t be a page name.\& Filenames can contain slashes and Oddmu creates
subdirectories as necessary.\&
.PP
Files may not end with a tilde ('\&~'\&) these are backup files.\& When saving pages
and file uploads, the old file is renamed to the backup file unless the backup
file is less than an hour old, thus collapsing all edits made in an hour into a
single diff when comparing backup and current version.\& The backup also gets an
updated timestamp so that subsequent edits don'\&t immediately overwrite it.\&
.PP
The \fBindex\fR page is the default page.\& People visiting the "root" of the site are
redirected to "/view/index".\&
.PP
The \fBchanges\fR page is where links to new and changed files are added.\& As an
author, you can prevent this from happening by deselecting the checkbox "Add
link to the list of changes.\&" The changes page can be edited like every other
page, so it'\&s easy to undo mistakes.\&
.PP
Links on the changes page are grouped by date.\& When new links are added, the
current date of the machine Oddmu is running on is used.\& If a link already
exists on the changes page, it is moved up to the current date.\& If that leaves
an old date without any links, that date heading is removed.\&
.PP
If you want to link to the changes page, you need to do this yourself.\& Add a
link from the index, for example.\& The "view.\&html" template currently doesn'\&t do
it.\& See \fIoddmu-templates\fR(5) if you want to add the link to the template.\&
.PP
A page whose name starts with an ISO date (YYYY-MM-DD, e.\&g.\& "2023-10-28") is
called a \fBblog\fR page.\& When creating or editing blog pages, links to it are added
from other pages.\&
.PP
If the blog page name starts with the current year, a link is created from the
index page back to the blog page being created or edited.\& Again, you can prevent
this from happening by deselecting the checkbox "Add link to the list of
changes.\&" The index page can be edited like every other page, so it'\&s easy to
undo mistakes.\&
.PP
For every \fBhashtag\fR used, another link might be created.\& If a page named like
the hashtag exists, a backlink is added to it, linking to the new or edited blog
page.\&
.PP
If a link to the new or edited blog page already exists but it'\&s title is no
longer correct, it is updated.\&
.PP
New links added for blog pages are added at the top of the first unnumbered list
using the asterisk ('\&*'\&).\& If no such list exists, a new one is started at the
bottom of the page.\& This allows you to have a different unnumbered list further
up on the page, as long as it uses the minus for items ('\&-'\&).\&
.PP
Changes made locally do not create any links on the changes page, the index page
or on any hashtag pages.\& See \fIoddmu-notify\fR(1) for a way to add the necessary
links to the changes page and possibly to the index and hashtag pages.\&
.PP
A hashtag consists of a number sign ('\&#'\&) followed by Unicode letters, numbers
or the underscore ('\&_'\&).\& Thus, a hashtag ends with punctuation or whitespace.\&
.PP
The page names, titles and hashtags are loaded into memory when the server
starts.\& If you have a lot of pages, this takes a lot of memory.\&
.PP
Oddmu watches the working directory and any subdirectories for changes made
directly.\& Thus, in theory, it'\&s not necessary to restart it after making such
changes.\&
.PP
You cannot edit uploaded files.\& If you upload a file called "hello.\&txt" and
attempt to edit it by using "/edit/hello.\&txt" you create a page with the name
"hello.\&txt.\&md" instead.\&
.PP
In order to delete uploaded files via the web, create an empty file and upload
it.\& In order to delete a wiki page, save an empty page.\&
.PP
Note that some HTML file names are special: they act as templates.\& See
\fIoddmu-templates\fR(5) for their names and their use.\&
.PP
.SH SEE ALSO
.PP
.PD 0
.IP \(bu 4
\fIoddmu\fR(5), about the markup syntax and how feeds are generated based on link
lists
.IP \(bu 4
\fIoddmu-releases\fR(7), on what features are part of the latest release
.IP \(bu 4
\fIoddmu-filter\fR(7), on how to treat subdirectories as separate sites
.IP \(bu 4
\fIoddmu-search\fR(7), on how search works
.IP \(bu 4
\fIoddmu-templates\fR(5), on how to write the HTML templates
.PD
.PP
If you run Oddmu as a web server:
.PP
.PD 0
.IP \(bu 4
\fIoddmu-apache\fR(5), on how to set up Apache as a reverse proxy
.IP \(bu 4
\fIoddmu-nginx\fR(5), on how to set up freenginx as a reverse proxy
.IP \(bu 4
\fIoddmu-webdav\fR(5), on how to set up Apache as a Web-DAV server
.IP \(bu 4
\fIoddmu.\&service\fR(5), on how to run the service under systemd
.PD
.PP
If you run Oddmu as a static site generator or pages offline and sync them with
Oddmu running as a webserver:
.PP
.PD 0
.IP \(bu 4
\fIoddmu-hashtags\fR(1), on working with hashtags
.IP \(bu 4
\fIoddmu-html\fR(1), on how to render a page
.IP \(bu 4
\fIoddmu-list\fR(1), on how to list pages and titles
.IP \(bu 4
\fIoddmu-links\fR(1), on how to list the outgoing links for a page
.IP \(bu 4
\fIoddmu-missing\fR(1), on how to find broken local links
.IP \(bu 4
\fIoddmu-notify\fR(1), on updating index, changes and hashtag pages
.IP \(bu 4
\fIoddmu-replace\fR(1), on how to search and replace text
.IP \(bu 4
\fIoddmu-search\fR(1), on how to run a search
.IP \(bu 4
\fIoddmu-static\fR(1), on generating a static site
.IP \(bu 4
\fIoddmu-toc\fR(1), on how to list the table of contents (toc) a page
.IP \(bu 4
\fIoddmu-version\fR(1), on how to get all the build information from the binary
.PD
.PP
If you want to stop using Oddmu:
.PP
.PD 0
.IP \(bu 4
\fIoddmu-export\fR(1), on how to export all the files as one big RSS file
.PD
.PP
.SH AUTHORS
.PP
Maintained by Alex Schroeder <alex@gnu.\&org>.\&

View File

@@ -56,6 +56,7 @@ directory:
- _/upload/dir/name_ shows a form to upload a file
- _/drop/dir/name_ saves an upload
- _/search/dir/?q=term_ to search for a term
- _/sitemap.xml_ to list the links to all the pages
- _/archive/dir/name.zip_ to download a zip file of a directory
When calling the _save_ and _append_ action, the page name is taken from the URL
@@ -317,12 +318,14 @@ Oddmu running as a webserver:
- _oddmu-hashtags_(1), on working with hashtags
- _oddmu-html_(1), on how to render a page
- _oddmu-feed_(1), on how to render a feed
- _oddmu-list_(1), on how to list pages and titles
- _oddmu-links_(1), on how to list the outgoing links for a page
- _oddmu-missing_(1), on how to find broken local links
- _oddmu-notify_(1), on updating index, changes and hashtag pages
- _oddmu-replace_(1), on how to search and replace text
- _oddmu-search_(1), on how to run a search
- _oddmu-sitemap_(1), on generating a static sitemap.xml
- _oddmu-static_(1), on generating a static site
- _oddmu-toc_(1), on how to list the table of contents (toc) a page
- _oddmu-version_(1), on how to get all the build information from the binary

View File

@@ -1,7 +1,6 @@
package main
import (
"github.com/stretchr/testify/assert"
"go/parser"
"go/token"
"io/fs"
@@ -12,6 +11,8 @@ import (
"sort"
"strings"
"testing"
"github.com/stretchr/testify/assert"
)
// Does oddmu(1) link to all the other man pages?
@@ -60,6 +61,40 @@ func TestManTemplates(t *testing.T) {
assert.Greater(t, count, 0, "no templates were found")
}
// Does oddmu-templates(5) mention all the templates?
func TestManTemplateAttributess(t *testing.T) {
mfp := "man/oddmu-templates.5.txt"
b, err := os.ReadFile(mfp)
man := string(b)
assert.NoError(t, err)
re := regexp.MustCompile(`{{(?:(?:if|range) )?(\.[A-Z][a-z]*)}}`)
filepath.Walk(".", func(fp string, info fs.FileInfo, err error) error {
if err != nil {
return err
}
if fp != "." && info.IsDir() {
return filepath.SkipDir
}
if !strings.HasSuffix(fp, ".html") {
return nil
}
h, err := os.ReadFile(fp)
matches := re.FindAllSubmatch(h, -1)
assert.Greater(t, len(matches), 0, "%s contains no attributes", fp)
seen := make(map[string]bool)
for _, m := range matches {
attr := string(m[1])
if seen[attr] {
continue
}
seen[attr] = true
assert.Contains(t, man, "_{{"+attr+"}}_", "%s does not mention _{{%s}}_", mfp, attr)
}
assert.NoError(t, err)
return nil
})
}
// Does oddmu(1) mention all the actions? We're not going to parse the go file and make sure to catch them all. I tried
// it, and it's convoluted.
func TestManActions(t *testing.T) {

View File

@@ -4,14 +4,15 @@ import (
"context"
"flag"
"fmt"
"github.com/gomarkdown/markdown"
"github.com/gomarkdown/markdown/ast"
"github.com/google/subcommands"
"io"
"net/url"
"os"
"path"
"strings"
"github.com/gomarkdown/markdown"
"github.com/gomarkdown/markdown/ast"
"github.com/google/subcommands"
)
type missingCmd struct {
@@ -32,6 +33,12 @@ func (cmd *missingCmd) SetFlags(f *flag.FlagSet) {
}
func (cmd *missingCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interface{}) subcommands.ExitStatus {
n, err := index.load()
if err != nil {
fmt.Fprintf(os.Stderr, "Index load: %s\n", err)
return subcommands.ExitFailure
}
fmt.Fprintf(os.Stderr, "Indexed %d pages\n", n)
return missingCli(os.Stdout, &index)
}
@@ -94,8 +101,7 @@ func (p *Page) links() []string {
doc := markdown.Parse(p.Body, parser)
ast.WalkFunc(doc, func(node ast.Node, entering bool) ast.WalkStatus {
if entering {
switch v := node.(type) {
case *ast.Link:
if v, ok := node.(*ast.Link); ok {
link := string(v.Destination)
url, err := url.Parse(link)
if err != nil {

View File

@@ -2,9 +2,10 @@ package main
import (
"bytes"
"testing"
"github.com/google/subcommands"
"github.com/stretchr/testify/assert"
"testing"
)
func TestMissingCmd(t *testing.T) {

View File

@@ -4,10 +4,11 @@ import (
"context"
"flag"
"fmt"
"github.com/google/subcommands"
"io"
"os"
"strings"
"github.com/google/subcommands"
)
type notifyCmd struct {
@@ -31,13 +32,12 @@ func (cmd *notifyCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interface
}
func notifyCli(w io.Writer, args []string) subcommands.ExitStatus {
index.load()
for _, name := range args {
if !strings.HasSuffix(name, ".md") {
fmt.Fprintf(os.Stderr, "%s does not end in '.md'\n", name)
return subcommands.ExitFailure
}
name = name[0:len(name)-3]
name = name[0 : len(name)-3]
p, err := loadPage(name)
if err != nil {
fmt.Fprintf(w, "Loading %s: %s\n", name, err)

30
page.go
View File

@@ -2,7 +2,6 @@ package main
import (
"bytes"
"github.com/microcosm-cc/bluemonday"
"html/template"
"log"
"net/url"
@@ -12,6 +11,8 @@ import (
"regexp"
"strings"
"time"
"github.com/microcosm-cc/bluemonday"
)
// Page is a struct containing information about a single page. Title is the title extracted from the page content using
@@ -21,7 +22,7 @@ type Page struct {
Title string
Name string
Body []byte
Html template.HTML
HTML template.HTML
Hashtags []string
}
@@ -29,7 +30,7 @@ type Page struct {
// the Name "foo").
type Link struct {
Title string
Url string
URL string
}
// blogRe is a regular expression that matches blog pages. If the filename of a blog page starts with an ISO date
@@ -61,7 +62,7 @@ func nameEscape(s string) string {
}
// save saves a Page. The path is based on the Page.Name and gets the ".md" extension. Page.Body is saved, without any
// carriage return characters ("\r"). Page.Title and Page.Html are not saved. There is no caching. Before removing or
// carriage return characters ("\r"). Page.Title and Page.HTML are not saved. There is no caching. Before removing or
// writing a file, the old copy is renamed to a backup, appending "~". Errors are not logged but returned.
func (p *Page) save() error {
fp := filepath.FromSlash(p.Name) + ".md"
@@ -88,6 +89,17 @@ func (p *Page) save() error {
return os.WriteFile(fp, s, 0644)
}
// ModTime returns the last modification time of the page file. If the page does not exist, the current time is
// returned.
func (p *Page) ModTime() (time.Time, error) {
fp := filepath.FromSlash(p.Name) + ".md"
fi, err := os.Stat(fp)
if err != nil {
return time.Now(), err
}
return fi.ModTime(), nil
}
// backup a file by renaming it unless the existing backup is less than an hour old. A backup gets a tilde appended to
// it ("~"). This is true even if the file refers to a binary file like "image.png" and most applications don't know
// what to do with a file called "image.png~". This expects a filepath. The backup file gets its modification time set
@@ -111,7 +123,7 @@ func backup(fp string) error {
}
// loadPage loads a Page given a name. The path loaded is that Page.Name with the ".md" extension. The Page.Title is set
// to the Page.Name (and possibly changed, later). The Page.Body is set to the file content. The Page.Html remains
// to the Page.Name (and possibly changed, later). The Page.Body is set to the file content. The Page.HTML remains
// undefined (there is no caching).
func loadPage(name string) (*Page, error) {
name = strings.TrimPrefix(name, "./") // result of a path.TreeWalk starting with "."
@@ -136,10 +148,10 @@ func (p *Page) handleTitle(replace bool) {
}
}
// summarize sets Page.Html to an extract.
// summarize sets Page.HTML to an extract.
func (p *Page) summarize(q string) {
t := p.plainText()
p.Html = sanitizeStrict(snippets(q, t))
p.HTML = sanitizeStrict(snippets(q, t))
}
// IsBlog returns true if the page name starts with an ISO date
@@ -163,7 +175,7 @@ func pathEncode(s string) string {
if n == 0 {
return s
}
t := make([]byte, len(s) + 2*n)
t := make([]byte, len(s)+2*n)
j := 0
for i := 0; i < len(s); i++ {
switch s[i] {
@@ -223,7 +235,7 @@ func (p *Page) Parents() []*Link {
if !ok {
title = "…"
}
link := &Link{Title: title, Url: strings.Repeat("../", len(elems)-i-1) + "index"}
link := &Link{Title: title, URL: strings.Repeat("../", len(elems)-i-1) + "index"}
links = append(links, link)
s += elems[i] + "/"
}

View File

@@ -1,9 +1,10 @@
package main
import (
"github.com/stretchr/testify/assert"
"regexp"
"testing"
"github.com/stretchr/testify/assert"
)
func TestPageTitle(t *testing.T) {
@@ -58,12 +59,12 @@ And untouchable`)}
// "testdata/parents/children/something/index" is a sibling and doesn't count!
parents := p.Parents()
assert.Equal(t, "Welcome to Oddμ", parents[0].Title)
assert.Equal(t, "../../../../index", parents[0].Url)
assert.Equal(t, "../../../../index", parents[0].URL)
assert.Equal(t, "…", parents[1].Title)
assert.Equal(t, "../../../index", parents[1].Url)
assert.Equal(t, "../../../index", parents[1].URL)
assert.Equal(t, "Solar", parents[2].Title)
assert.Equal(t, "../../index", parents[2].Url)
assert.Equal(t, "../../index", parents[2].URL)
assert.Equal(t, "Lunar", parents[3].Title)
assert.Equal(t, "../index", parents[3].Url)
assert.Equal(t, "../index", parents[3].URL)
assert.Equal(t, 4, len(parents))
}

View File

@@ -2,12 +2,13 @@ package main
import (
"bytes"
"net/url"
"path"
"github.com/gomarkdown/markdown"
"github.com/gomarkdown/markdown/ast"
"github.com/gomarkdown/markdown/html"
"github.com/gomarkdown/markdown/parser"
"net/url"
"path"
)
// wikiLink returns an inline parser function. This indirection is
@@ -89,12 +90,12 @@ func wikiRenderer() *html.Renderer {
return renderer
}
// renderHtml renders the Page.Body to HTML and sets Page.Html, Page.Hashtags, and escapes Page.Name.
func (p *Page) renderHtml() {
// renderHTML renders the Page.Body to HTML and sets Page.HTML, Page.Hashtags, and escapes Page.Name.
func (p *Page) renderHTML() {
parser, hashtags := wikiParser()
renderer := wikiRenderer()
maybeUnsafeHTML := markdown.ToHTML(p.Body, parser, renderer)
p.Html = unsafeBytes(maybeUnsafeHTML)
p.HTML = unsafeBytes(maybeUnsafeHTML)
p.Hashtags = *hashtags
}
@@ -133,8 +134,7 @@ func (p *Page) images() []ImageData {
doc := markdown.Parse(p.Body, parser)
ast.WalkFunc(doc, func(node ast.Node, entering bool) ast.WalkStatus {
if entering {
switch v := node.(type) {
case *ast.Image:
if v, ok := node.(*ast.Image); ok {
// not an absolute URL, not a full URL, not a mailto: URI
text := toString(v)
if len(text) > 0 {
@@ -164,8 +164,7 @@ func toString(node ast.Node) string {
b := new(bytes.Buffer)
ast.WalkFunc(node, func(node ast.Node, entering bool) ast.WalkStatus {
if entering {
switch v := node.(type) {
case *ast.Text:
if v, ok := node.(*ast.Text); ok {
b.Write(v.Literal)
}
}

View File

@@ -1,8 +1,9 @@
package main
import (
"github.com/stretchr/testify/assert"
"testing"
"github.com/stretchr/testify/assert"
)
func TestPagePlainText(t *testing.T) {
@@ -19,14 +20,14 @@ func TestPageHtml(t *testing.T) {
Silver leaves shine bright
They droop, boneless, weak and sad
A cruel sun stares down`)}
p.renderHtml()
p.renderHTML()
r := `<h1 id="sun">Sun</h1>
<p>Silver leaves shine bright
They droop, boneless, weak and sad
A cruel sun stares down</p>
`
assert.Equal(t, r, string(p.Html))
assert.Equal(t, r, string(p.HTML))
}
func TestPageHtmlHashtag(t *testing.T) {
@@ -36,7 +37,7 @@ Too faint to focus, so far
I am cold, alone
#Haiku #Cold_Poets`)}
p.renderHtml()
p.renderHTML()
r := `<h1 id="comet">Comet</h1>
<p>Stars flicker above
@@ -45,7 +46,7 @@ I am cold, alone</p>
<p><a class="tag" href="/search/?q=%23Haiku">#Haiku</a> <a class="tag" href="/search/?q=%23Cold_Poets">#Cold Poets</a></p>
`
assert.Equal(t, r, string(p.Html))
assert.Equal(t, r, string(p.HTML))
}
func TestPageHtmlHashtagCornerCases(t *testing.T) {
@@ -53,13 +54,13 @@ func TestPageHtmlHashtagCornerCases(t *testing.T) {
ok # #o #ok
[oh #ok \#nok](ok)`)}
p.renderHtml()
p.renderHTML()
r := `<p>#</p>
<p>ok # <a class="tag" href="/search/?q=%23o">#o</a> <a class="tag" href="/search/?q=%23ok">#ok</a>
<a href="ok">oh #ok #nok</a></p>
`
assert.Equal(t, r, string(p.Html))
assert.Equal(t, r, string(p.HTML))
}
func TestPageHtmlWikiLink(t *testing.T) {
@@ -67,14 +68,14 @@ func TestPageHtmlWikiLink(t *testing.T) {
Blue and green and black
Sky and grass and [ragged cliffs](cliffs)
Our [[time together]]`)}
p.renderHtml()
p.renderHTML()
r := `<h1 id="photos-and-books">Photos and Books</h1>
<p>Blue and green and black
Sky and grass and <a href="cliffs">ragged cliffs</a>
Our <a href="time%20together">time together</a></p>
`
assert.Equal(t, r, string(p.Html))
assert.Equal(t, r, string(p.HTML))
}
func TestPageHtmlDollar(t *testing.T) {
@@ -82,34 +83,34 @@ func TestPageHtmlDollar(t *testing.T) {
Dragonfly hovers
darts chases turns lands and rests
A mighty jewel`)}
p.renderHtml()
p.renderHTML()
r := `<h1 id="no-dollar-can-buy-this">No $dollar$ can buy this</h1>
<p>Dragonfly hovers
darts chases turns lands and rests
A mighty jewel</p>
`
assert.Equal(t, r, string(p.Html))
assert.Equal(t, r, string(p.HTML))
}
func TestLazyLoadImages(t *testing.T) {
p := &Page{Body: []byte(`![](test.jpg)`)}
p.renderHtml()
assert.Contains(t, string(p.Html), "lazy")
p.renderHTML()
assert.Contains(t, string(p.HTML), "lazy")
}
// The fractions available in Latin 1 (?) are rendered.
func TestFractions(t *testing.T) {
p := &Page{Body: []byte(`1/4`)}
p.renderHtml()
assert.Contains(t, string(p.Html), "&frac14;")
p.renderHTML()
assert.Contains(t, string(p.HTML), "&frac14;")
}
// Other fractions are not rendered.
func TestNoFractions(t *testing.T) {
p := &Page{Body: []byte(`1/6`)}
p.renderHtml()
assert.Contains(t, string(p.Html), "1/6")
p.renderHTML()
assert.Contains(t, string(p.HTML), "1/6")
}
// webfinger
@@ -119,17 +120,17 @@ func TestAt(t *testing.T) {
// prevent lookups
accounts.Lock()
accounts.uris = make(map[string]string)
accounts.uris["alex@alexschroeder.ch"] = "https://social.alexschroeder.ch/@alex";
accounts.uris["alex@alexschroeder.ch"] = "https://social.alexschroeder.ch/@alex"
accounts.Unlock()
// test account
p := &Page{Body: []byte(`My fedi handle is @alex@alexschroeder.ch.`)}
p.renderHtml()
assert.Contains(t,string(p.Html),
p.renderHTML()
assert.Contains(t, string(p.HTML),
`My fedi handle is <a class="account" href="https://social.alexschroeder.ch/@alex" title="@alex@alexschroeder.ch">@alex</a>.`)
// test escaped account
p = &Page{Body: []byte(`My fedi handle is \@alex@alexschroeder.ch. \`)}
p.renderHtml()
assert.Contains(t,string(p.Html),
p.renderHTML()
assert.Contains(t, string(p.HTML),
`My fedi handle is @alex@alexschroeder.ch.`)
// disable webfinger
useWebfinger = false

View File

@@ -14,12 +14,12 @@ import (
// are passed on the the {viewHandler}.
func previewHandler(w http.ResponseWriter, r *http.Request, path string) {
if r.Method != http.MethodPost {
http.Redirect(w, r, "/view/" + strings.TrimPrefix(path, "/preview/"), http.StatusFound)
http.Redirect(w, r, "/view/"+strings.TrimPrefix(path, "/preview/"), http.StatusFound)
return
}
body := strings.ReplaceAll(r.FormValue("body"), "\r", "")
p := &Page{Name: path, Body: []byte(body)}
p.handleTitle(true)
p.renderHtml()
p.renderHTML()
renderTemplate(w, p.Dir(), "preview", p)
}

View File

@@ -23,7 +23,7 @@ img { max-width: 100% }
</header>
<main>
<h1>Previewing {{.Title}}</h1>
{{.Html}}
{{.HTML}}
</main>
<hr>
<section id="edit">

View File

@@ -1,10 +1,11 @@
package main
import (
"github.com/stretchr/testify/assert"
"net/url"
"net/http"
"net/url"
"testing"
"github.com/stretchr/testify/assert"
)
func TestPreview(t *testing.T) {

View File

@@ -4,10 +4,6 @@ import (
"context"
"flag"
"fmt"
"github.com/google/subcommands"
"github.com/hexops/gotextdiff"
"github.com/hexops/gotextdiff/myers"
"github.com/hexops/gotextdiff/span"
"io"
"io/fs"
"os"
@@ -15,6 +11,11 @@ import (
"regexp"
"slices"
"strings"
"github.com/google/subcommands"
"github.com/hexops/gotextdiff"
"github.com/hexops/gotextdiff/myers"
"github.com/hexops/gotextdiff/span"
)
type replaceCmd struct {
@@ -63,9 +64,8 @@ func replaceCli(w io.Writer, isConfirmed bool, isRegexp bool, args []string) sub
if fp != "." && strings.HasPrefix(filepath.Base(fp), ".") {
if info.IsDir() {
return filepath.SkipDir
} else {
return nil
}
return nil
}
// skipp all but page files
if !strings.HasSuffix(fp, ".md") {
@@ -80,14 +80,14 @@ func replaceCli(w io.Writer, isConfirmed bool, isRegexp bool, args []string) sub
changes++
if isConfirmed {
fmt.Fprintln(w, fp)
_ = os.Rename(fp, fp + "~")
_ = os.Rename(fp, fp+"~")
err = os.WriteFile(fp, result, 0644)
if err != nil {
return err
}
} else {
edits := myers.ComputeEdits(span.URIFromPath(fp + "~"), string(body), string(result))
diff := fmt.Sprint(gotextdiff.ToUnified(fp + "~", fp, string(body), edits))
edits := myers.ComputeEdits(span.URIFromPath(fp+"~"), string(body), string(result))
diff := fmt.Sprint(gotextdiff.ToUnified(fp+"~", fp, string(body), edits))
fmt.Fprintln(w, diff)
}
}

View File

@@ -2,9 +2,10 @@ package main
import (
"bytes"
"testing"
"github.com/google/subcommands"
"github.com/stretchr/testify/assert"
"testing"
)
func TestReplaceCmd(t *testing.T) {

View File

@@ -67,11 +67,12 @@ func sortNames(tokens []string) func(a, b string) int {
na := unicode.IsNumber(ra)
rb, _ := utf8.DecodeRuneInString(b)
nb := unicode.IsNumber(rb)
if na && !nb {
switch {
case na && !nb:
return -1
} else if !na && nb {
case !na && nb:
return 1
} else if na && nb {
case na && nb:
if a < b {
return 1
} else if a > b {
@@ -99,7 +100,7 @@ func sortNames(tokens []string) func(a, b string) int {
// results.
const itemsPerPage = 20
// search returns a sorted []Page where each page contains an extract of the actual Page.Body in its Page.Html. Page
// search returns a sorted []Page where each page contains an extract of the actual Page.Body in its Page.HTML. Page
// size is 20. Specify either the page number to return, or that all the results should be returned. Only ask for all
// results if runtime is not an issue, like on the command line. The boolean return value indicates whether there are
// more results.
@@ -140,7 +141,7 @@ func search(q, dir, filter string, page int, all bool) ([]*Result, bool) {
if strings.Contains(title, term) {
re, err := re(term)
if err == nil {
img.Html = template.HTML(highlight(re, img.Title))
img.HTML = template.HTML(highlight(re, img.Title))
}
res = append(res, img)
continue ImageLoop
@@ -199,14 +200,15 @@ func filterNames(names, predicates []string) []string {
defer index.RUnlock()
for _, predicate := range predicates {
r := make([]string, 0)
if strings.HasPrefix(predicate, "title:") {
switch {
case strings.HasPrefix(predicate, "title:"):
token := predicate[6:]
for _, name := range names {
if strings.Contains(strings.ToLower(index.titles[name]), token) {
r = append(r, name)
}
}
} else if predicate == "blog:true" || predicate == "blog:false" {
case predicate == "blog:true" || predicate == "blog:false":
blog := predicate == "blog:true"
re := regexp.MustCompile(`(^|/)\d\d\d\d-\d\d-\d\d`)
for _, name := range names {
@@ -215,7 +217,7 @@ func filterNames(names, predicates []string) []string {
r = append(r, name)
}
}
} else {
default:
log.Printf("Unsupported predicate: %s", predicate)
}
names = intersection(names, r)

View File

@@ -40,9 +40,9 @@ button { background-color: #eee; color: inherit; border-radius: 4px; border-widt
<article lang="{{.Language}}">
<p><a class="result" href="/view/{{.Path}}">{{.Title}}</a>
<span class="score">{{.Score}}</span></p>
<blockquote>{{.Html}}</blockquote>
<blockquote>{{.HTML}}</blockquote>
{{range .Images}}
<p class="image"><a href="/view/{{.Path}}"><img loading="lazy" src="/view/{{.Path}}"></a><br/>{{.Html}}
<p class="image"><a href="/view/{{.Path}}"><img loading="lazy" src="/view/{{.Path}}"></a><br/>{{.HTML}}
{{end}}
</article>
{{end}}

View File

@@ -4,14 +4,15 @@ import (
"context"
"flag"
"fmt"
"github.com/google/subcommands"
"github.com/muesli/reflow/wordwrap"
"io"
"net/url"
"os"
"path/filepath"
"regexp"
"strings"
"github.com/google/subcommands"
"github.com/muesli/reflow/wordwrap"
)
type searchCmd struct {
@@ -70,14 +71,15 @@ func searchCli(w io.Writer, cmd *searchCmd, args []string) subcommands.ExitStatu
fmt.Fprint(os.Stderr, " results\n")
}
}
if cmd.extract {
switch {
case cmd.extract:
searchExtract(w, items)
} else if cmd.files {
case cmd.files:
for _, p := range items {
name := filepath.FromSlash(p.Name) + ".md\n"
fmt.Fprintf(w, name)
}
} else {
default:
for _, p := range items {
name := p.Name
if strings.HasPrefix(name, dir) {
@@ -98,7 +100,7 @@ func searchExtract(w io.Writer, items []*Result) {
match := func(s string) string { return "\x1b[1m" + s + "\x1b[0m" } // bold
re := regexp.MustCompile(`<b>(.*?)</b>`)
for _, p := range items {
s := re.ReplaceAllString(string(p.Html), match(`$1`))
s := re.ReplaceAllString(string(p.HTML), match(`$1`))
fmt.Fprintln(w, heading(p.Title))
if p.Name != p.Title {
fmt.Fprintln(w, p.Name)

View File

@@ -2,9 +2,10 @@ package main
import (
"bytes"
"testing"
"github.com/google/subcommands"
"github.com/stretchr/testify/assert"
"testing"
)
func TestSearchCmd(t *testing.T) {

View File

@@ -2,11 +2,12 @@ package main
import (
"fmt"
"github.com/stretchr/testify/assert"
"net/http"
"net/url"
"slices"
"testing"
"github.com/stretchr/testify/assert"
)
func TestSortNames(t *testing.T) {
@@ -262,7 +263,7 @@ Please call me, my love.
assert.NotEmpty(t, items[0].Images)
assert.Equal(t, "phone call", items[0].Images[0].Title)
assert.Equal(t, "phone <b>call</b>", string(items[0].Images[0].Html))
assert.Equal(t, "phone <b>call</b>", string(items[0].Images[0].HTML))
assert.Equal(t, "testdata/images/2024-07-21.jpg", items[0].Images[0].Name)
assert.Empty(t, items[1].Images)

48
sitemap.go Normal file
View File

@@ -0,0 +1,48 @@
package main
import (
"log"
"net/http"
"os"
"regexp"
)
type SitemapURL struct {
Loc string
}
type Sitemap struct {
URL []*SitemapURL
}
// sitemapHandler lists all the pages. See https://www.sitemaps.org/protocol.html for more. It takes the
// ODDMU_FILTER environment variable into account.
func sitemapHandler(w http.ResponseWriter, r *http.Request) {
if r.URL.Path != "/sitemap.xml" {
http.NotFound(w, r)
} else {
w.Write([]byte(`<?xml version="1.0" encoding="UTF-8"?>`))
base := r.URL.Scheme + "://" + r.URL.Host + "/view/"
filter := os.Getenv("ODDMU_FILTER")
renderTemplate(w, ".", "sitemap", sitemap(&index, base, filter))
}
}
// sitemap generates the list of URLs. A reference to the index needs to be provided to make it easier to write
// tests. Exclude pages matching the filter.
func sitemap(idx *indexStore, base, filter string) Sitemap {
url := make([]*SitemapURL, 0)
re, err := regexp.Compile(filter)
if err != nil {
log.Println("ODDMU_FILTER does not compile:", filter, err)
return Sitemap{URL: url}
}
idx.RLock()
defer idx.RUnlock()
for name := range idx.titles {
if !re.MatchString(name) {
url = append(url, &SitemapURL{Loc: base + name})
}
}
return Sitemap{URL: url}
}

3
sitemap.html Normal file
View File

@@ -0,0 +1,3 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
{{range .URL}}<url><loc>{{.Loc}}</loc></url>
{{end}}</urlset>

62
sitemap_cmd.go Normal file
View File

@@ -0,0 +1,62 @@
package main
import (
"context"
"fmt"
"flag"
"io"
"log"
"os"
"github.com/google/subcommands"
)
type sitemapCmd struct {
base string
filter string
}
func (cmd *sitemapCmd) SetFlags(f *flag.FlagSet) {
f.StringVar(&cmd.base, "base", "http://localhost:8080/view/", "the base URL for the sitemap")
f.StringVar(&cmd.filter, "filter", "", "a regular expression to filter pages")
}
func (*sitemapCmd) Name() string { return "sitemap" }
func (*sitemapCmd) Synopsis() string { return "list all the pages known in Sitemap format" }
func (*sitemapCmd) Usage() string {
return `sitemap [-base URL] [-filter regex]:
Print all the pages known in Sitemap format.
See https://www.sitemaps.org/ for more.
`
}
func (cmd *sitemapCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interface{}) subcommands.ExitStatus {
n, err := index.load()
if err != nil {
fmt.Fprintf(os.Stderr, "Index load: %s\n", err)
return subcommands.ExitFailure
}
fmt.Fprintf(os.Stderr, "Indexed %d pages\n", n)
return sitemapCli(os.Stdout, &index, cmd.base, cmd.filter)
}
// sitemapCli implements the printing of a Sitemap. In order to make testing easier, it takes a Writer and an
// indexStore. The Writer is important so that test code can provide a buffer instead of os.Stdout; the indexStore
// is important so that test code can ensure no other test running in parallel can interfere with the list of known
// pages (by adding or deleting pages).
func sitemapCli(w io.Writer, idx *indexStore, base, filter string) subcommands.ExitStatus {
loadTemplates()
template := "sitemap.html"
t := templates.template[template]
if t == nil {
log.Println("Template not found:", template)
return subcommands.ExitFailure
}
w.Write([]byte(`<?xml version="1.0" encoding="UTF-8"?>` + "\n"))
err := t.Execute(w, sitemap(idx, base, filter))
if err != nil {
log.Println(err)
return subcommands.ExitFailure
}
return subcommands.ExitSuccess
}

18
sitemap_cmd_test.go Normal file
View File

@@ -0,0 +1,18 @@
package main
import (
"bytes"
"testing"
"github.com/google/subcommands"
"github.com/stretchr/testify/assert"
)
func TestSitemapCmd(t *testing.T) {
b := new(bytes.Buffer)
s := sitemapCli(b, minimalIndex(t), "https://example.org/view/", "^themes/")
assert.Equal(t, subcommands.ExitSuccess, s)
assert.Contains(t, b.String(), "https://example.org/view/index")
assert.Contains(t, b.String(), "https://example.org/view/README")
assert.NotContains(t, b.String(), "https://example.org/view/themes/")
}

View File

@@ -90,9 +90,9 @@ func snippets(q string, s string) string {
}
}
t = s[start:end]
res = res + t
res += t
if len(s) > end {
res = res + " …"
res += " …"
}
// truncate text to avoid rematching the same string.
s = s[end:]

View File

@@ -1,8 +1,9 @@
package main
import (
"github.com/stretchr/testify/assert"
"testing"
"github.com/stretchr/testify/assert"
)
func TestSnippets(t *testing.T) {

View File

@@ -19,7 +19,7 @@ img { max-width: 100% }
<body>
<main id="main">
<h1>{{.Title}}</h1>
{{.Html}}
{{.HTML}}
</main>
<footer>
<address>

View File

@@ -5,10 +5,8 @@ import (
"context"
"flag"
"fmt"
"github.com/gomarkdown/markdown"
"github.com/gomarkdown/markdown/ast"
"github.com/gomarkdown/markdown/html"
"github.com/google/subcommands"
"image/jpeg"
"io"
"io/fs"
"net/url"
"os"
@@ -16,14 +14,28 @@ import (
"slices"
"strings"
"time"
"github.com/disintegration/imaging"
"github.com/edwvee/exiffix"
"github.com/gen2brain/webp"
"github.com/gomarkdown/markdown"
"github.com/gomarkdown/markdown/ast"
"github.com/gomarkdown/markdown/html"
"github.com/google/subcommands"
)
type staticCmd struct {
jobs int
jobs int
shrink bool
glob string
verbose bool
}
func (cmd *staticCmd) SetFlags(f *flag.FlagSet) {
f.IntVar(&cmd.jobs, "jobs", 2, "how many jobs to use")
f.BoolVar(&cmd.shrink, "shrink", false, "shrink images by decreasing the quality")
f.StringVar(&cmd.glob, "glob", "", "only export files matching this shell file name pattern")
f.BoolVar(&cmd.verbose, "verbose", false, "print the files as they are being processed")
}
func (*staticCmd) Name() string { return "static" }
@@ -38,11 +50,11 @@ func (*staticCmd) Usage() string {
func (cmd *staticCmd) Execute(_ context.Context, f *flag.FlagSet, _ ...interface{}) subcommands.ExitStatus {
args := f.Args()
if len(args) != 1 {
fmt.Fprintln(os.Stderr, "Exactly one target directory is required")
fmt.Fprintln(os.Stderr, "Exactly one target directory is require", args)
return subcommands.ExitFailure
}
dir := filepath.Clean(args[0])
return staticCli(".", dir, cmd.jobs, false)
return staticCli(".", dir, cmd.jobs, cmd.glob, cmd.shrink, cmd.verbose, false)
}
type args struct {
@@ -52,20 +64,20 @@ type args struct {
// staticCli generates a static site in the designated directory. The quiet flag is used to suppress output when running
// tests. The source directory cannot be set from the command-line. The current directory (".") is assumed.
func staticCli(source, target string, jobs int, quiet bool) subcommands.ExitStatus {
func staticCli(source, target string, jobs int, glob string, shrink, verbose, quiet bool) subcommands.ExitStatus {
index.load()
index.RLock()
defer index.RUnlock()
loadLanguages()
loadTemplates()
tasks := make(chan args)
results := make(chan error)
done := make(chan bool)
tasks := make(chan args, 10000)
results := make(chan error, jobs)
done := make(chan bool, jobs)
stop := make(chan error)
for i := 0; i < jobs; i++ {
go staticWorker(tasks, results, done)
go staticWorker(tasks, results, done, shrink, verbose)
}
go staticWalk(source, target, tasks, stop)
go staticWalk(source, target, glob, tasks, stop)
go staticWatch(jobs, results, done)
n, err := staticProgressIndicator(results, stop, quiet)
if !quiet {
@@ -81,13 +93,15 @@ func staticCli(source, target string, jobs int, quiet bool) subcommands.ExitStat
// staticWalk walks the source directory tree. Any directory it finds, it recreates in the target directory. Any file it
// finds, it puts into the tasks channel for the staticWorker. When the directory walk is finished, the tasks channel is
// closed. If there's an error on the stop channel, the walk returns that error.
func staticWalk(source, target string, tasks chan (args), stop chan (error)) {
func staticWalk(source, target, glob string, tasks chan (args), stop chan (error)) {
// The error returned here is what's in the stop channel but at the very end, a worker might return an error
// even though the walk is already done. This is why we cannot rely on the return value of the walk.
filepath.Walk(source, func(fp string, info fs.FileInfo, err error) error {
n := 0
err := filepath.Walk(source, func(fp string, info fs.FileInfo, err error) error {
if err != nil {
return err
}
// don't wait for the stop channel
select {
case err := <-stop:
return err
@@ -96,14 +110,30 @@ func staticWalk(source, target string, tasks chan (args), stop chan (error)) {
if fp != "." && strings.HasPrefix(filepath.Base(fp), ".") {
if info.IsDir() {
return filepath.SkipDir
} else {
return nil
}
return nil
}
// skip backup files, avoid recursion
if strings.HasSuffix(fp, "~") || strings.HasPrefix(fp, target) {
return nil
}
// skip templates
if slices.Contains(templateFiles, filepath.Base(fp)) {
return nil
}
// skip files that don't match the glob, if set
if fp != "." && glob != "" {
match, err := filepath.Match(glob, fp)
if err != nil {
return err // abort
}
if !match {
if info.IsDir() {
return filepath.SkipDir
}
return nil
}
}
// determine the actual target: if source is a/ and target is b/ and path is a/file, then the
// target is b/file
var actualTarget string
@@ -115,18 +145,32 @@ func staticWalk(source, target string, tasks chan (args), stop chan (error)) {
}
actualTarget = filepath.Join(target, fp[len(source):])
}
// recreate subdirectories
// recreate subdirectories, ignore existing ones
if info.IsDir() {
return os.Mkdir(actualTarget, 0755)
os.Mkdir(actualTarget, 0755)
return nil
}
// Markdown files end up as HTML files
if strings.HasSuffix(actualTarget, ".md") {
actualTarget = actualTarget[:len(actualTarget)-3] + ".html"
}
// do the task if the target file doesn't exist or if the source file is newer
other, err := os.Stat(actualTarget)
if err != nil || info.ModTime().After(other.ModTime()) {
if err == nil {
fmt.Println(fp, info.ModTime(), other.ModTime(), info.ModTime().After(other.ModTime()))
}
n++
tasks <- args{source: fp, target: actualTarget, info: info}
}
return nil
}
})
if err != nil {
fmt.Println(err)
} else {
fmt.Printf("\r%d files to process\n", n)
}
close(tasks)
}
@@ -141,55 +185,114 @@ func staticWatch(jobs int, results chan (error), done chan (bool)) {
// staticWorker takes arguments off the tasks channel (the file to process) and put results in the results channel (any
// errors encountered); when they're done they send true on the done channel.
func staticWorker(tasks chan (args), results chan (error), done chan (bool)) {
func staticWorker(tasks chan (args), results chan (error), done chan (bool), shrink, verbose bool) {
task, ok := <-tasks
for ok {
results <- staticFile(task.source, task.target, task.info)
if verbose {
fmt.Println(task.source)
}
results <- staticFile(task.source, task.target, task.info, shrink)
task, ok = <-tasks
}
done <- true
}
// staticProgressIndicator watches the results channel and does a countdown. If the result channel reports an error,
// that is put into the stop channel so that staticWalk stops adding to the tasks channel.
// staticProgressIndicator watches the results channel and prints a running count. If the result channel reports an
// error, that is put into the stop channel so that staticWalk stops adding to the tasks channel.
func staticProgressIndicator(results chan (error), stop chan (error), quiet bool) (int, error) {
n := 0
t := time.Now()
var err error
for result := range results {
if result != nil {
err := result
// this stops the walker from adding more tasks
stop <- err
} else {
n++
if !quiet && n%13 == 0 {
if time.Since(t) > time.Second {
fmt.Printf("\r%d", n)
t = time.Now()
}
err, ok := <-results
for ok && err == nil {
n++
if !quiet && n%13 == 0 {
if time.Since(t) > time.Second {
fmt.Printf("\r%d", n)
t = time.Now()
}
}
err, ok = <-results
}
if ok && err != nil {
// this stops the walker from adding more tasks
stop <- err
}
return n, err
}
// staticFile is used to walk the file trees and do the right thing for the destination directory: create
// subdirectories, link files, render HTML files.
func staticFile(source, target string, info fs.FileInfo) error {
func staticFile(source, target string, info fs.FileInfo, shrink bool) error {
// render pages
if strings.HasSuffix(source, ".md") {
p, err := staticPage(source[:len(source)-3], target[:len(target)-3]+".html")
// target already has ".html" extension
p, err := staticPage(source[:len(source)-3], target)
if err != nil {
return err
}
return staticFeed(source[:len(source)-3], target[:len(target)-3]+".rss", p, info.ModTime())
return staticFeed(source[:len(source)-3], target[:len(target)-5]+".rss", p, info.ModTime())
}
// remaining files are linked unless this is a template
if slices.Contains(templateFiles, filepath.Base(source)) {
if shrink {
switch filepath.Ext(source) {
case ".jpg", ".jpeg", ".webp":
return shrinkImage(source, target, info)
}
}
// delete before linking, ignore errors
os.Remove(target)
err := os.Link(source, target)
if err == nil {
return nil
}
return os.Link(source, target)
// in case of invalid cross-device link error, copy file instead
src, err := os.Open(source)
if err != nil {
return err
}
defer src.Close()
dst, err := os.Create(target)
if err != nil {
return err
}
defer dst.Close()
_, err = io.Copy(dst, src)
return err
}
var shrinkWidth = 800
var shrinkQuality = 10
// shrink Image shrinks images down and reduces the quality dramatically.
func shrinkImage(source, target string, info fs.FileInfo) error {
file, err := os.Open(source)
if err != nil {
return err
}
defer file.Close()
img, _, err := exiffix.Decode(file)
if err != nil {
return fmt.Errorf("%s cannot be decoded", source)
}
if img.Bounds().Dx() > shrinkWidth {
res := imaging.Resize(img, shrinkWidth, 0, imaging.Lanczos) // preserve aspect ratio
// imaging functions don't return errors but empty images…
if res.Rect.Empty() {
return fmt.Errorf("%s cannot be resized", source)
}
img = res
}
dst, err := os.Create(target)
if err != nil {
return err
}
defer dst.Close()
switch filepath.Ext(source) {
case ".jpg", ".jpeg":
err = jpeg.Encode(dst, img, &jpeg.Options{Quality: shrinkQuality})
case ".webp":
err = webp.Encode(dst, img, webp.Options{Quality: shrinkQuality})
}
return err
}
// staticPage takes the filename of a page (ending in ".md") and generates a static HTML page.
@@ -200,7 +303,7 @@ func staticPage(source, target string) (*Page, error) {
return nil, err
}
p.handleTitle(true)
// instead of p.renderHtml() we do it all ourselves, appending ".html" to all the local links
// instead of p.renderHTML() we do it all ourselves, appending ".html" to all the local links
parser, hashtags := wikiParser()
doc := markdown.Parse(p.Body, parser)
ast.WalkFunc(doc, staticLinks)
@@ -210,7 +313,7 @@ func staticPage(source, target string) (*Page, error) {
}
renderer := html.NewRenderer(opts)
maybeUnsafeHTML := markdown.Render(doc, renderer)
p.Html = unsafeBytes(maybeUnsafeHTML)
p.HTML = unsafeBytes(maybeUnsafeHTML)
p.Hashtags = *hashtags
return p, write(p, target, "", "static.html")
}
@@ -221,7 +324,7 @@ func staticFeed(source, target string, p *Page, ti time.Time) error {
base := filepath.Base(source)
_, ok := index.token[strings.ToLower(base)]
if base == "index" || ok {
f := feed(p, ti)
f := feed(p, ti, 0, 10, ModTime)
if len(f.Items) > 0 {
return write(f, target, `<?xml version="1.0" encoding="UTF-8"?>`, "feed.html")
}
@@ -232,8 +335,7 @@ func staticFeed(source, target string, p *Page, ti time.Time) error {
// staticLinks checks a node and if it is a link to a local page, it appends ".html" to the link destination.
func staticLinks(node ast.Node, entering bool) ast.WalkStatus {
if entering {
switch v := node.(type) {
case *ast.Link:
if v, ok := node.(*ast.Link); ok {
// not an absolute URL, not a full URL, not a mailto: URI
if !bytes.HasPrefix(v.Destination, []byte("/")) &&
!bytes.Contains(v.Destination, []byte("://")) &&

View File

@@ -1,15 +1,16 @@
package main
import (
"github.com/google/subcommands"
"github.com/stretchr/testify/assert"
"os"
"testing"
"github.com/google/subcommands"
"github.com/stretchr/testify/assert"
)
func TestStaticCmd(t *testing.T) {
cleanup(t, "testdata/static")
s := staticCli(".", "testdata/static", 2, true)
s := staticCli(".", "testdata/static", 2, "", false, false, true)
assert.Equal(t, subcommands.ExitSuccess, s)
// pages
assert.FileExists(t, "testdata/static/index.html")
@@ -34,7 +35,7 @@ And the cars so loud
`)}
h.save()
h.notify()
s := staticCli("testdata/static-feed", "testdata/static-feed-out", 2, true)
s := staticCli("testdata/static-feed", "testdata/static-feed-out", 2, "", false, false, true)
assert.Equal(t, subcommands.ExitSuccess, s)
assert.FileExists(t, "testdata/static-feed-out/2024-03-07-poem.html")
assert.FileExists(t, "testdata/static-feed-out/Haiku.html")

View File

@@ -11,11 +11,11 @@ import (
"sync"
)
// templateFiles are the various HTML template files used. These files must exist in the root directory for Oddmu to be
// able to generate HTML output. This always requires a template.
// templateFiles are the various HTML template files used. These files must exist in the root directory for Oddmu
// to be able to generate HTML output. This always requires a template.
var templateFiles = []string{"edit.html", "add.html", "view.html", "preview.html",
"diff.html", "search.html", "static.html", "upload.html", "feed.html",
"list.html" }
"sitemap.html"}
// templateStore controls access to map of parsed HTML templates. Make sure to lock and unlock as appropriate. See
// renderTemplate and loadTemplates.

View File

@@ -2,10 +2,11 @@ package main
import (
"bytes"
"github.com/stretchr/testify/assert"
"mime/multipart"
"net/http"
"testing"
"github.com/stretchr/testify/assert"
)
func TestTemplates(t *testing.T) {
@@ -21,7 +22,7 @@ Memories of cold
assert.Contains(t,
assert.HTTPBody(makeHandler(viewHandler, false, http.MethodGet), "GET", "/view/testdata/templates/snow", nil), "Skip")
// save a new view handler
html := "<body><h1>{{.Title}}</h1>{{.Html}}"
html := "<body><h1>{{.Title}}</h1>{{.HTML}}"
form := new(bytes.Buffer)
writer := multipart.NewWriter(form)
field, err := writer.CreateFormField("filename")

View File

@@ -17,7 +17,7 @@
<title>{{.Title}}</title>
<link>https://alexschroeder.ch/view/{{.Path}}</link>
<guid>https://alexschroeder.ch/view/{{.Path}}</guid>
<description>{{.Html}}</description>
<description>{{.HTML}}</description>
<pubDate>{{.Date}}</pubDate>
{{range .Hashtags}}
<category>{{.}}</category>

View File

@@ -48,9 +48,9 @@ button { background-color: #eee; color: inherit; border-radius: 4px; border-widt
<article lang="{{.Language}}">
<p><a class="result" href="/view/{{.Path}}">{{.Title}}</a>
<span class="score">{{.Score}}</span></p>
<blockquote>{{.Html}}</blockquote>
<blockquote>{{.HTML}}</blockquote>
{{range .Images}}
<p class="image"><a href="/view/{{.Path}}"><img loading="lazy" src="/view/{{.Path}}"></a><br/>{{.Html}}
<p class="image"><a href="/view/{{.Path}}"><img loading="lazy" src="/view/{{.Path}}"></a><br/>{{.HTML}}
{{end}}
</article>
{{end}}

View File

@@ -29,7 +29,7 @@ img { max-width: 100% }
<body>
<main id="main">
<h1>{{.Title}}</h1>
{{.Html}}
{{.HTML}}
</main>
<footer>
<address>

View File

@@ -54,7 +54,7 @@ img { max-width: 100% }
</header>
<main id="main">
<h1>{{.Title}}</h1>
{{.Html}}
{{.HTML}}
</main>
<footer>
<address>

View File

@@ -16,7 +16,7 @@
<title>{{.Title}}</title>
<link>https://campaignwiki.org/view/{{.Path}}</link>
<guid>https://campaignwiki.org/view/{{.Path}}</guid>
<description>{{.Html}}</description>
<description>{{.HTML}}</description>
<pubDate>{{.Date}}</pubDate>
{{range .Hashtags}}
<category>{{.}}</category>

View File

@@ -39,7 +39,7 @@ img { max-width: 20% }
<article lang="{{.Language}}">
<p><a class="result" href="/view/{{.Path}}">{{.Title}}</a>
<span class="score">{{.Score}}</span></p>
<blockquote>{{.Html}}</blockquote>
<blockquote>{{.HTML}}</blockquote>
</article>
{{end}}
<p>

View File

@@ -19,7 +19,7 @@ img { max-width: 100% }
<body>
<main id="main">
<h1>{{.Title}}</h1>
{{.Html}}
{{.HTML}}
</main>
<footer>
<address>

View File

@@ -41,7 +41,7 @@ img { max-width: 100% }
</header>
<main>
<h1>{{.Title}}</h1>
{{.Html}}
{{.HTML}}
</main>
<footer>
<address>

View File

@@ -37,7 +37,7 @@ button { font-size: large; background-color: #eee; color: inherit; border-radius
<article lang="{{.Language}}">
<p><a class="result" href="/view/{{.Path}}">{{.Title}}</a>
<span class="score">{{.Score}}</span></p>
<blockquote>{{.Html}}</blockquote>
<blockquote>{{.HTML}}</blockquote>
</article>
{{end}}
<p>

View File

@@ -62,7 +62,7 @@ img { max-width: 100%; margin-top: 5px }
<h1>{{.Title}}</h1>
</header>
<main>
{{.Html}}
{{.HTML}}
</main>
<footer>
<form action="/append/{{.Path}}" method="POST">

View File

@@ -16,7 +16,7 @@
<title>{{.Title}}</title>
<link>https://campaignwiki.org/view/{{.Name}}</link>
<guid>https://campaignwiki.org/view/{{.Name}}</guid>
<description>{{.Html}}</description>
<description>{{.HTML}}</description>
<pubDate>{{.Date}}</pubDate>
{{range .Hashtags}}
<category>{{.}}</category>

View File

@@ -24,7 +24,7 @@ img { max-width: 100% }
</header>
<main>
<h1>Previewing {{.Title}}</h1>
{{.Html}}
{{.HTML}}
</main>
<hr>
<section id="edit">

View File

@@ -40,9 +40,9 @@ button { background-color: #eee; color: inherit; border-radius: 4px; border-widt
<article lang="{{.Language}}">
<p><a class="result" href="/view/{{.Path}}">{{.Title}}</a>
<span class="score">{{.Score}}</span></p>
<blockquote>{{.Html}}</blockquote>
<blockquote>{{.HTML}}</blockquote>
{{range .Images}}
<p class="image"><a href="/view/{{.Path}}"><img loading="lazy" src="/view/{{.Path}}"></a><br/>{{.Html}}
<p class="image"><a href="/view/{{.Path}}"><img loading="lazy" src="/view/{{.Path}}"></a><br/>{{.HTML}}
{{end}}
</article>
{{end}}

View File

@@ -19,7 +19,7 @@ img { max-width: 100% }
<body>
<main id="main">
<h1>{{.Title}}</h1>
{{.Html}}
{{.HTML}}
</main>
<footer>
<address>

View File

@@ -43,7 +43,7 @@ img { max-width: 100% }
</header>
<main id="main">
<h1>{{.Title}}</h1>
{{.Html}}
{{.HTML}}
</main>
<footer>
<address>

View File

@@ -10,7 +10,7 @@
<title>{{.Title}}</title>
<link>https://flying-carpet.ch/view/{{.Path}}</link>
<guid>https://flying-carpet.ch/view/{{.Path}}</guid>
<description>{{.Html}}</description>
<description>{{.HTML}}</description>
<pubDate>{{.Date}}</pubDate>
{{range .Hashtags}}
<category>{{.}}</category>

View File

@@ -38,7 +38,7 @@ img { max-width: 20% }
<article lang="{{.Language}}">
<p><a class="result" href="/view/{{.Path}}">{{.Title}}</a>
<span class="score">{{.Score}}</span></p>
<blockquote>{{.Html}}</blockquote>
<blockquote>{{.HTML}}</blockquote>
</article>
{{end}}
<p>

View File

@@ -19,7 +19,7 @@ img { max-width: 100% }
<body>
<main id="main">
<h1>{{.Title}}</h1>
{{.Html}}
{{.HTML}}
</main>
<footer>
<address>

View File

@@ -34,7 +34,7 @@ img { max-width: 100% }
</header>
<main id="main">
<h1>{{.Title}}</h1>
{{.Html}}
{{.HTML}}
</main>
</body>
</html>

Some files were not shown because too many files have changed in this diff Show More