templum

README

templum

A static site generator for templ.

Install

go install github.com/cugu/templum/cmd/templum@latest

Usage

Generate a site from the content folder to the public folder:

templum --content content --output public --user "https://cugu.github.io/templum/"

Content

Content is written in Markdown.

The content directory structure is:

content
├── config.yaml
├── index.md
├── 1 Something.md
├── 2 Something else.md
│   ├── 1 My Topic .md
│   └── 2 My Other Topic.md
├── 3 Another thing.md
└── logo.svg

config.yaml

The config file contains the site base url and the GitHub url:

github_url: "https://github.com/cugu/templum" # optional
logo: "templum.svg"
title: "templum"

d2_sketch: false  # default
d2_theme_name: "Vanilla nitro cola"  # see for more themes: https://pkg.go.dev/oss.terrastruct.com/d2/d2themes/d2themescatalog
d2_layout: degre  # default, optional: elk
# style: | # optional, to set custom css
#     .prose {
#         max-width: 120ch !important;
#     }

Folders and Markdown files

The folder structure is used to create the navigation. Number prefixes are used to order the pages and are removed from the navigation.

Documentation

Index

• func Generate(ctx context.Context, baseURL, contentPath string, theme Theme, ...) error
• func Markdown(c *PageContext, md string) templ.Component
• type MemoryFS
• type MemoryFile
• type Page
  • func NewMarkdownPage(fsys fs.FS, path string) *Page
  • func NewSectionPage(path string) *Page
  • func (p *Page) AddChildren(child ...*Page)
  • func (p *Page) Children() []*Page
  • func (p *Page) Link() string
  • func (p *Page) Markdown() (string, error)
  • func (p *Page) Order() int
  • func (p *Page) Title() string
  • func (p *Page) Type() PageType
• type PageContext
• type PageType
• type SiteContext
• type Theme

Functions

func Generate

func Generate(ctx context.Context, baseURL, contentPath string, theme Theme, outputPath string) error

func Markdown

func Markdown(c *PageContext, md string) templ.Component

Types

type MemoryFS

type MemoryFS = fstest.MapFS

type MemoryFile

type MemoryFile = fstest.MapFile

type Page

type Page struct {
	// contains filtered or unexported fields
}

func NewMarkdownPage

func NewMarkdownPage(fsys fs.FS, path string) *Page

func NewSectionPage

func NewSectionPage(path string) *Page

func (*Page) AddChildren

func (p *Page) AddChildren(child ...*Page)

func (*Page) Children

func (p *Page) Children() []*Page

func (*Page) Link

func (p *Page) Link() string

func (*Page) Markdown

func (p *Page) Markdown() (string, error)

func (*Page) Order

func (p *Page) Order() int

func (*Page) Title

func (p *Page) Title() string

func (*Page) Type

func (p *Page) Type() PageType

type PageContext

type PageContext struct {
	*SiteContext

	Page *Page
}

type PageType

type PageType int

const (
	Section PageType = iota
	MarkdownPage
)

type SiteContext

type SiteContext struct {
	BaseURL    string
	Config     map[string]string
	Pages      []*Page
	OtherFiles fs.FS
}

type Theme

type Theme interface {
	Render(ctx context.Context, siteContext *SiteContext) (fs.FS, error)
}