diff options
| author | Nicolas Paul <n@nc0.fr> | 2023-05-31 00:27:36 +0200 |
|---|---|---|
| committer | Nicolas Paul <n@nc0.fr> | 2023-05-31 00:27:36 +0200 |
| commit | 2c359752da4bcdf4566e7d2986fb99d7e4de36f9 (patch) | |
| tree | 73f2400a91d963ae6b46b92533f4709c5f25c9a4 /templates.go | |
| parent | 0dee7eab679c96a97591788fc1bf5d291fa51303 (diff) | |
Move templates into pkg directory
Signed-off-by: Nicolas Paul <n@nc0.fr>
Diffstat (limited to 'templates.go')
| -rw-r--r-- | templates.go | 82 |
1 files changed, 0 insertions, 82 deletions
diff --git a/templates.go b/templates.go deleted file mode 100644 index 1024325..0000000 --- a/templates.go +++ /dev/null @@ -1,82 +0,0 @@ -package main - -import ( - "fmt" - "html/template" - "io" -) - -// HTML document templates -var ( - // indexTmpl is the HTML template for the root of the static site. - // It redirects to a site configured by the user. - // - // {{.Count}} corresponds to the timer—in seconds— before redirecting. - // {{.Redirect}} is the URL to redirect visitors to. - indexTmpl *template.Template = template.Must( - template.New("index").Parse(`<!DOCTYPE html> -<meta charset="UTF-8"> -<meta http-equiv="refresh" content="{{.Count}}; url='{{.Redirect}}'"> -<meta name="viewport" content="width=device-width,initial-scale=1"> -<p>Nothing to see, redirecting <a href="{{.Redirect}}">here</a>.`)) - - // moduleTmpl is the HTML template for module-specific documents. - // They include information for the Go toolchain to find and download - // the module source code. It also redirects users to the module's - // documentation on pkg.go.dev. - // - // {{.Prefix}} is the module's prefix, a.k.a. import path, - // e.g. example.com/foo - // {{.Vcs}} is the version control system used in the codebase - // {{.Home}} is the repository's home. - // {{.Dir}} is a URL template to a page listing the files inside a package - // {{.File}} is a URL template listing the lines of a file - // {{.Doc}} is the URL of the module's documentation on pkg.go.dev - // - // Templates support a specific set of substitutions which are documented - // here: https://github.com/golang/gddo/wiki/Source-Code-Links - moduleTmpl *template.Template = template.Must( - template.New("module").Parse(`<!DOCTYPE html> -<meta charset="UTF-8"> -<meta name="go-import" content="{{.Prefix}} {{.Vcs}} {{.Home}}"> -<meta name="go-source" content="{{.Prefix}} {{.Home}} {{.Dir}} {{.File}}"> -<meta name="viewport" content="width=device-width,initial-scale=1"> -<p>There is nothing to see, redirecting <a href="{{.Doc}}">here</a>.`)) -) - -// ExecIndex constructs an HTML document for the index of the generated site -// in the given writer "w." -// The document redirects visitor to the specified "url" after "count" seconds. -func ExecIndex(w io.Writer, url string, count uint8) error { - return indexTmpl.Execute(w, struct { - Redirect string - Count uint8 - }{ - Redirect: url, - Count: count, - }) -} - -// ExecModule constructs an HTML document for a module indexed on the domain -// in the given writer "w." The "prefix" corresponds to the import path of the -// module, "vcs" to the version control system used — git, bazaar..., "home" -// is the repository's home and "dir"/"file" are URL templates as documented -// by GoDoc: https://github.com/golang/gddo/wiki/Source-Code-Links. -func ExecModule(w io.Writer, prefix, vcs, - home, dir, file string) error { - return moduleTmpl.Execute(w, struct { - Prefix string - Vcs string - Home string - Dir string - File string - Doc string - }{ - Prefix: prefix, - Vcs: vcs, - Home: home, - Dir: dir, - File: file, - Doc: fmt.Sprintf("https://pkg.go.dev/%s", prefix), - }) -} |