mirror of
https://codeberg.org/readeck/readeck.git
synced 2025-12-23 21:50:15 +00:00
ca8693c2d1
- new Etagger that must implement a GetSumReader method - fixed "tager" spelling - use fnv instead of crc64 to hash etag values
71 lines
1.5 KiB
Go
71 lines
1.5 KiB
Go
// SPDX-FileCopyrightText: © 2023 Olivier Meunier <olivier@neokraft.net>
|
|
//
|
|
// SPDX-License-Identifier: AGPL-3.0-only
|
|
|
|
// Package docs handles Readeck's documentation files and HTTP routes.
|
|
package docs
|
|
|
|
import (
|
|
"embed"
|
|
"encoding/json"
|
|
"hash"
|
|
"io/fs"
|
|
"net/http"
|
|
)
|
|
|
|
//go:embed assets assets/* licenses/*
|
|
var assets embed.FS
|
|
|
|
// Files contains all the generated help files as an http.FS instance.
|
|
var Files http.FileSystem
|
|
|
|
// File is a documentation file.
|
|
type File struct {
|
|
Route string `json:"route"`
|
|
Aliases []string `json:"aliases"`
|
|
File string `json:"file"`
|
|
Etag string `json:"etag"`
|
|
IsDocument bool `json:"is_document"`
|
|
Title string `json:"title"`
|
|
Meta map[string]any `json:"meta"`
|
|
}
|
|
|
|
// Section is a documentation language section.
|
|
type Section struct {
|
|
Files map[string]*File `json:"files"`
|
|
TOC [][2]string `json:"toc"`
|
|
}
|
|
|
|
// Manifest is the documentation files manifest.
|
|
type Manifest struct {
|
|
Files map[string]*File `json:"files"`
|
|
Sections map[string]*Section `json:"sections"`
|
|
}
|
|
|
|
var manifest *Manifest
|
|
|
|
// UpdateEtag implements the [server.Etagger] interface.
|
|
func (f *File) UpdateEtag(h hash.Hash) {
|
|
h.Write([]byte(f.Etag))
|
|
}
|
|
|
|
func init() {
|
|
sub, err := fs.Sub(assets, "assets")
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
Files = http.FS(sub)
|
|
|
|
// Load manifest
|
|
fd, err := assets.Open("assets/manifest.json")
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
dec := json.NewDecoder(fd)
|
|
err = dec.Decode(&manifest)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
}
|