files

Documentation

Index

• Constants
• Variables
• func IsComponentFolder(name string) bool
• func IsContentExt(ext string) bool
• func IsContentFile(filename string) bool
• func IsHTMLFile(filename string) bool
• func IsIndexContentFile(filename string) bool
• func ResolveComponentFolder(filename string) string
• type ContentClass
  • func ClassifyContentFile(filename string, open func() (afero.File, error)) ContentClass
  • func (c ContentClass) IsBundle() bool

Constants

const (
	// The NPM package.json "template" file.
	FilenamePackageHugoJSON = "package.hugo.json"
	// The NPM package file.
	FilenamePackageJSON = "package.json"
)

const (
	ComponentFolderArchetypes = "archetypes"
	ComponentFolderStatic     = "static"
	ComponentFolderLayouts    = "layouts"
	ComponentFolderContent    = "content"
	ComponentFolderData       = "data"
	ComponentFolderAssets     = "assets"
	ComponentFolderI18n       = "i18n"

	FolderResources = "resources"
	FolderJSConfig  = "_jsconfig" // Mounted below /assets with postcss.config.js etc.
)

Variables

var (
	JsConfigFolderMountPrefix = filepath.Join(ComponentFolderAssets, FolderJSConfig)

	ComponentFolders = []string{
		ComponentFolderArchetypes,
		ComponentFolderStatic,
		ComponentFolderLayouts,
		ComponentFolderContent,
		ComponentFolderData,
		ComponentFolderAssets,
		ComponentFolderI18n,
	}
)

Functions

func IsComponentFolder

func IsComponentFolder(name string) bool

func IsContentExt

func IsContentExt(ext string) bool

func IsContentFile

func IsContentFile(filename string) bool

func IsHTMLFile

func IsHTMLFile(filename string) bool

func IsIndexContentFile

func IsIndexContentFile(filename string) bool

func ResolveComponentFolder

func ResolveComponentFolder(filename string) string

ResolveComponentFolder returns "content" from "content/blog/foo.md" etc.

Types

type ContentClass

type ContentClass string

const (
	ContentClassLeaf    ContentClass = "leaf"
	ContentClassBranch  ContentClass = "branch"
	ContentClassFile    ContentClass = "zfile" // Sort below
	ContentClassContent ContentClass = "zcontent"
)

func ClassifyContentFile

func ClassifyContentFile(filename string, open func() (afero.File, error)) ContentClass

func (ContentClass) IsBundle

func (c ContentClass) IsBundle() bool