templum

package module

v0.0.0-...-b819d50 Latest Latest Go to latest Published: Apr 15, 2024 License: GPL-3.0 Imports: 27 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/cugu/templum

Links

Open Source Insights

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"
logo: "templum.svg"
title: "templum"

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(md string) templ.Component
type MemoryFS
type MemoryFile
type Page
- func NewMarkdownPage(fsys fs.FS, path string) *Page
- func NewSectionPage(path string) *Page
type PageContext
type PageType
type SiteContext
type Theme

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Generate ¶

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

func Markdown ¶

func Markdown(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)
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
templum
theme
plain templ: version: v0.2.639	templ: version: v0.2.639
plain/static

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL