Documentation
¶
Index ¶
- Constants
- Variables
- func ProvisionStudio(ctx context.Context, d *kernel.Deps, in ProvisionInput) error
- func Render(doc Document) (string, error)
- func Validate(doc Document) error
- func ValidatePublication(doc Document) error
- type BlockSpec
- type ComparisonCell
- type ComparisonRow
- type Document
- type Draft
- type Entry
- type LayoutRevision
- type Module
- type NativeOptions
- type ProvisionInput
- type Section
- type SectionFact
Constants ¶
View Source
const ( RevisionKindSave = "save" RevisionKindPublish = "publish" RevisionKindRestore = "restore" RevisionKindReset = "reset" )
View Source
const (
SectionLibrary = "sections"
)
Variables ¶
View Source
var ErrConflict = errors.New("builder: document changed; reload before saving")
View Source
var ErrForbidden = content.ErrForbidden
View Source
var ErrNotFound = content.ErrNotFound
View Source
var ErrProfile = errors.New("builder: invalid site profile")
Functions ¶
func ProvisionStudio ¶
ProvisionStudio resumes its own interrupted import, never adopts an existing site.
func ValidatePublication ¶
ValidatePublication allows incomplete drafts but requires a visible page heading for publishing.
Types ¶
type ComparisonCell ¶ added in v0.17.0
type ComparisonRow ¶ added in v0.17.0
type ComparisonRow struct {
Label string `json:"label"`
Cells []ComparisonCell `json:"cells"`
}
type Entry ¶
type Entry struct {
Icon string `json:"icon,omitempty" enum:",bolt,shield,chart,globe,clock,check,layers"`
Featured bool `json:"featured,omitempty"`
Title string `json:"title"`
Text string `json:"text"`
Image string `json:"image"`
ImageAlt string `json:"image_alt"`
Link string `json:"link"`
Price string `json:"price"`
}
type LayoutRevision ¶ added in v0.2.0
type LayoutRevision struct {
ID string `json:"id"`
ContentID string `json:"content_id"`
Kind string `json:"kind"`
AuthorID string `json:"author_id"`
CreatedAt string `json:"created_at"`
SectionCount int `json:"section_count"`
Summary string `json:"summary"`
Document Document `json:"document"`
}
LayoutRevision is one stored page-builder layout snapshot.
type NativeOptions ¶ added in v0.17.0
type NativeOptions struct {
Eyebrow string `json:"eyebrow,omitempty"`
Background string `json:"background,omitempty" enum:",inherit,none,dots,grid,lines,circles,waves,paper,solid"`
SecondaryLink string `json:"secondary_link,omitempty"`
SecondaryLabel string `json:"secondary_label,omitempty"`
Facts []SectionFact `json:"facts,omitempty"`
Columns []string `json:"columns,omitempty"`
Rows []ComparisonRow `json:"rows,omitempty"`
Caption string `json:"caption,omitempty"`
Illustration bool `json:"illustration,omitempty"`
}
NativeOptions describes only editable content/options supported by the existing gp-s section stylesheet. It accepts no arbitrary class, CSS or HTML.
type ProvisionInput ¶
type ProvisionInput struct{ Title, Template, Locale, Email string }
ProvisionInput selects a complete editable website for an empty tenant.
type Section ¶
type Section struct {
Library string `` /* 126-byte string literal not displayed */
Native *NativeOptions `json:"native,omitempty"`
HeroScene string `json:"hero_scene,omitempty"`
Feed string `json:"feed,omitempty"`
ID string `json:"id"`
Kind string `json:"kind"`
Variant string `json:"variant"`
Title string `json:"title"`
Text string `json:"text"`
Image string `json:"image"`
ImageAlt string `json:"image_alt"`
Link string `json:"link"`
LinkLabel string `json:"link_label"`
Items []Entry `json:"items"`
Hidden bool `json:"hidden"`
}
func DefaultSection ¶
type SectionFact ¶ added in v0.17.0
Source Files
¶
- admin.go
- admin_history.go
- api.go
- history.go
- identity_admin.go
- model.go
- module.go
- native_model.go
- native_render.go
- profile.go
- provision.go
- readiness.go
- readiness_admin.go
- readiness_content.go
- render.go
- site_design.go
- starter_admin.go
- starter_catalog.go
- starter_company.go
- starter_design.go
- starter_magazine.go
- starter_portfolio.go
- starter_preview.go
- starters.go
- store.go
Click to show internal directories.
Click to hide internal directories.