hugofs

Documentation

Overview

Package hugofs provides the file systems used by Hugo.

Index

• func Destination() afero.Fs
• func InitDefaultFs()
• func InitFs(fs afero.Fs)
• func InitMemFs()
• func Os() afero.Fs
• func SetDestination(fs afero.Fs)
• func SetSource(fs afero.Fs)
• func Source() afero.Fs
• func WorkingDir() *afero.BasePathFs

Functions

func Destination

func Destination() afero.Fs

Destination returns Hugo's destionation file system.

func InitDefaultFs

func InitDefaultFs()

InitDefaultFs initializes with the OS file system as source and destination file systems.

func InitFs

func InitFs(fs afero.Fs)

InitFs initializes with the given file system as source and destination file systems.

func InitMemFs

func InitMemFs()

InitMemFs initializes with a MemMapFs as source and destination file systems. Useful for testing.

func Os

func Os() afero.Fs

Os returns an OS file system.

func SetDestination

func SetDestination(fs afero.Fs)

SetDestination sets Hugo's destionation file system

func SetSource

func SetSource(fs afero.Fs)

SetSource sets Hugo's source file system and re-initializes dependent file systems.

func Source

func Source() afero.Fs

Source returns Hugo's source file system.

func WorkingDir

func WorkingDir() *afero.BasePathFs

WorkingDir returns a read-only file system restricted to the project working dir.