helpers

package

Go to main page

Versions in this module

v0

v0.47.1

Aug 20, 2018

Changes in this version

+ func OpenFileForWriting(fs afero.Fs, filename string) (afero.File, error)

+ func OpenFilesForWriting(fs afero.Fs, filenames ...string) (io.WriteCloser, error)

v0.45.1

Jul 25, 2018

Changes in this version

+ func ExtNoDelimiter(in string) string

+ func PathAndExt(in string) (string, string)

+ func ToSlashTrimLeading(s string) string

v0.42.2

Jun 28, 2018

v0.42.1

Jun 13, 2018

Changes in this version

+ func PrintFs(fs afero.Fs, path string, w io.Writer)

type BlackFriday

+ NofollowLinks bool

+ NoreferrerLinks bool

type DistinctLogger

+ func NewDistinctLogger(logger LogPrinter) *DistinctLogger

+ type LogPrinter interface

+ Println func(a ...interface{})

type PathSpec

+ func NewPathSpecWithBaseBaseFsProvided(fs *hugofs.Fs, cfg config.Provider, baseBaseFs *filesystems.BaseFs) (*PathSpec, error)

+ func (p *PathSpec) GetFirstThemeDir() string

+ func (p *PathSpec) GetThemesDir() string

v0.40.3

May 9, 2018

v0.40.2

Apr 30, 2018

v0.40.1

Apr 25, 2018

v0.38.2

Apr 9, 2018

v0.38.1

Apr 5, 2018

Changes in this version

+ var ErrPathTooShort = errors.New("file path is too short")

+ func LstatIfPossible(fs afero.Fs, path string) (os.FileInfo, error)

type Language

+ ContentDir string

+ Disabled bool

type PathSpec

+ BaseFs *hugofs.BaseFs

+ func (p *PathSpec) ContentDirs() []types.KeyValueStr

+ func (p *PathSpec) RelContentDir(filename string) (string, string)

v0.37.1

Mar 7, 2018

Changes in this version

+ func DiffStrings(s1, s2 string) []string

type HugoVersion

+ func (v HugoVersion) Version() HugoVersionString

+ type HugoVersionString string

+ func (h HugoVersionString) Compare(other interface{}) int

+ func (h HugoVersionString) Eq(other interface{}) bool

+ func (h HugoVersionString) String() string

v0.36.1

Feb 15, 2018

Changes in this version

type Language

+ func (l *Language) GetStringSlice(key string) []string

v0.32.4

Jan 11, 2018

v0.32.3

Jan 8, 2018

Changes in this version

type PathSpec

+ BasePath string

+ Language *Language

+ Languages Languages

v0.32.2

Jan 3, 2018

v0.32.1

Jan 2, 2018

Changes in this version

+ func FileAndExt(in string) (string, string)

+ func LstatIfOs(fs afero.Fs, path string) (info os.FileInfo, err error)

+ func MD5FromFile(f afero.File) (string, error)

+ func MD5FromFileFast(f afero.File) (string, error)

+ func MD5String(f string) string

+ func ProcessingStatsTable(w io.Writer, stats ...*ProcessingStats)

+ type BlackFriday struct

+ AngledQuotes bool

+ Extensions []string

+ ExtensionsMask []string

+ Fractions bool

+ HrefTargetBlank bool

+ LatexDashes bool

+ PlainIDAnchors bool

+ SmartDashes bool

+ Smartypants bool

+ SmartypantsQuotesNBSP bool

+ TaskLists bool

type ContentSpec

+ BlackFriday *BlackFriday

+ BuildDrafts bool

+ BuildExpired bool

+ BuildFuture bool

type PathSpec

+ ProcessingStats *ProcessingStats

+ PublishDir string

+ func (p *PathSpec) ContentDir() string

+ func (p *PathSpec) GetLangSubDir(lang string) string

+ func (p *PathSpec) PermalinkForBaseURL(link, baseURL string) string

+ type ProcessingStats struct

+ Aliases uint64

+ Cleaned uint64

+ Files uint64

+ Name string

+ Pages uint64

+ PaginatorPages uint64

+ ProcessedImages uint64

+ Sitemaps uint64

+ Static uint64

+ func NewProcessingStats(name string) *ProcessingStats

+ func (s *ProcessingStats) Add(counter *uint64, amount int)

+ func (s *ProcessingStats) Incr(counter *uint64)

+ func (s *ProcessingStats) Table(w io.Writer)

v0.31.1

Nov 27, 2017

Changes in this version

type Language

+ func (l *Language) GetLocal(key string) interface{}

type Languages

+ func (l Languages) IsMultihost() bool

type PathSpec

+ func (p *PathSpec) StaticDirs() []string

+ func (p *PathSpec) ThemesDir() string

v0.30.2

Oct 19, 2017

v0.30.1

Oct 19, 2017

Changes in this version

type ContentSpec

+ Highlight func(code, lang, optsStr string) (string, error)

+ func (c *ContentSpec) TruncateWordsByRune(words []string) (string, bool)

+ func (c *ContentSpec) TruncateWordsToWholeSentence(s string) (string, bool)

v0.27.1

Sep 13, 2017

Changes in this version

+ func GetTitleFunc(style string) func(s string) string

+ func HasAsciidoctor() bool

type Blackfriday

+ SmartypantsQuotesNBSP bool

v0.25.1

Jul 10, 2017

Changes in this version

+ func HasStringsPrefix(s, prefix []string) bool

+ func HasStringsSuffix(s, suffix []string) bool

type HugoVersion

+ func MustParseHugoVersion(s string) HugoVersion

+ func ParseHugoVersion(s string) (HugoVersion, error)

v0.24.1

Jun 24, 2017

Changes in this version

+ func Ext(in string) string

type PathSpec

+ Cfg config.Provider

+ Fs *hugofs.Fs

v0.22.1

Jun 13, 2017

v0.20.7

May 3, 2017

v0.20.6

Apr 27, 2017

v0.20.5

Apr 25, 2017

v0.20.4

Apr 24, 2017

v0.20.3

Apr 24, 2017

Changes in this version

+ var CurrentHugoVersion = HugoVersion

type HugoVersion

+ Number float32

+ PatchLevel int

+ Suffix string

+ func (v HugoVersion) Next() HugoVersion

+ func (v HugoVersion) NextPatchLevel(level int) HugoVersion

+ func (v HugoVersion) Prev() HugoVersion

+ func (v HugoVersion) ReleaseVersion() HugoVersion

+ func (v HugoVersion) String() string

v0.20.2

Apr 16, 2017

v0.20.1

Apr 13, 2017

Changes in this version

+ var DistinctWarnLog = NewDistinctWarnLogger()

+ var ErrThemeUndefined = errors.New("no theme set")

+ func CompareVersion(version interface{}) int

+ type BaseURL struct

+ func (b BaseURL) String() string

+ func (b BaseURL) URL() *url.URL

+ func (b BaseURL) WithProtocol(protocol string) (string, error)

+ type ContentSpec struct

+ func NewContentSpec(cfg config.Provider) *ContentSpec

+ func (c ContentSpec) NewBlackfriday() *Blackfriday

+ func (c ContentSpec) RenderBytes(ctx *RenderingContext) []byte

type DistinctLogger

+ func NewDistinctWarnLogger() *DistinctLogger

type HugoMmarkHTMLRenderer

+ Cfg config.Provider

type Language

+ Cfg config.Provider

+ func (l *Language) IsSet(key string) bool

+ func (l *Language) Set(key string, value interface{})

type PathSpec

+ func NewPathSpec(fs *hugofs.Fs, cfg config.Provider) (*PathSpec, error)

+ func (p *PathSpec) AbsPathify(inPath string) string

+ func (p *PathSpec) GetLayoutDirPath() string

+ func (p *PathSpec) GetRelativeThemeDir() string

+ func (p *PathSpec) GetStaticDirPath() string

+ func (p *PathSpec) GetThemeDataDirPath() (string, error)

+ func (p *PathSpec) GetThemeDir() string

+ func (p *PathSpec) GetThemeI18nDirPath() (string, error)

+ func (p *PathSpec) GetThemeStaticDirPath() (string, error)

+ func (p *PathSpec) GetThemesDirPath() string

+ func (p *PathSpec) LayoutDir() string

+ func (p *PathSpec) MakeStaticPathRelative(inPath string) (string, error)

+ func (p *PathSpec) PrependBasePath(rel string) string

+ func (p *PathSpec) Theme() string

+ func (p *PathSpec) ThemeSet() bool

+ func (p *PathSpec) URLEscape(uri string) string

+ func (p *PathSpec) URLizeFilename(filename string) string

+ func (p *PathSpec) WorkingDir() string

+ func (p PathSpec) String() string

type RenderingContext

+ Cfg config.Provider

v0.18.1

Dec 29, 2016

Changes in this version

+ const FilePathSeparator

+ const HugoPatchVersion

+ const HugoVersionNumber

+ const HugoVersionSuffix

+ var DistinctErrorLog = NewDistinctErrorLogger()

+ var DistinctFeedbackLog = NewDistinctFeedbackLogger()

+ var ErrWalkRootTooShort = errors.New("Path too short. Stop walking.")

+ var SummaryDivider = []byte("")

+ var SummaryLength = 70

+ func AbsPathify(inPath string) string

+ func AddContextRoot(baseURL, relativePath string) string

+ func BytesToHTML(b []byte) template.HTML

+ func Deprecated(object, item, alternative string, err bool)

+ func DiffStringSlices(slice1 []string, slice2 []string) []string

+ func DirExists(path string, fs afero.Fs) (bool, error)

+ func DoArithmetic(a, b interface{}, op rune) (interface{}, error)

+ func Emojify(source []byte) []byte

+ func Exists(path string, fs afero.Fs) (bool, error)

+ func ExtractRootPaths(paths []string) []string

+ func ExtractTOC(content []byte) (newcontent []byte, toc []byte)

+ func FileContains(filename string, subslice []byte, fs afero.Fs) (bool, error)

+ func FileContainsAny(filename string, subslices [][]byte, fs afero.Fs) (bool, error)

+ func Filename(in string) (name string)

+ func FindAvailablePort() (*net.TCPAddr, error)

+ func FindCWD() (string, error)

+ func FirstUpper(s string) string

+ func GetDottedRelativePath(inPath string) string

+ func GetLayoutDirPath() string

+ func GetRealPath(fs afero.Fs, path string) (string, error)

+ func GetRelativePath(path, base string) (final string, err error)

+ func GetRelativeThemeDir() string

+ func GetStaticDirPath() string

+ func GetTempDir(subPath string, fs afero.Fs) string

+ func GetThemeDataDirPath() (string, error)

+ func GetThemeDir() string

+ func GetThemeI18nDirPath() (string, error)

+ func GetThemeStaticDirPath() (string, error)

+ func GetThemesDirPath() string

+ func GuessSection(in string) string

+ func GuessType(in string) string

+ func HasAsciidoc() bool

+ func HasPygments() bool

+ func HasRst() bool

+ func Highlight(code, lang, optsStr string) string

+ func HugoReleaseVersion() string

+ func HugoVersion() string

+ func InStringArray(arr []string, el string) bool

+ func InitConfigProviderForCurrentContentLanguage()

+ func InitLoggers()

+ func IsAbsURL(path string) bool

+ func IsDir(path string, fs afero.Fs) (bool, error)

+ func IsEmpty(path string, fs afero.Fs) (bool, error)

+ func IsWhitespace(r rune) bool

+ func MakePermalink(host, plink string) *url.URL

+ func MakeStaticPathRelative(inPath string) (string, error)

+ func MakeTitle(inpath string) string

+ func Md5String(f string) string

+ func NextHugoReleaseVersion() string

+ func NormalizeHugoFlags(f *pflag.FlagSet, name string) pflag.NormalizedName

+ func PaginateAliasPath(base string, page int) string

+ func PathPrep(ugly bool, in string) string

+ func PrettifyPath(in string) string

+ func PrettifyURL(in string) string

+ func PrettifyURLPath(in string) string

+ func ReaderContains(r io.Reader, subslice []byte) bool

+ func ReaderToBytes(lines io.Reader) []byte

+ func ReaderToString(lines io.Reader) string

+ func RenderBytes(ctx *RenderingContext) []byte

+ func ReplaceExtension(path string, newExt string) string

+ func ResetConfigProvider()

+ func SafeWriteToDisk(inpath string, r io.Reader, fs afero.Fs) (err error)

+ func SanitizeURL(in string) string

+ func SanitizeURLKeepTrailingSlash(in string) string

+ func Seq(args ...interface{}) ([]int, error)

+ func SliceToLower(s []string) []string

+ func StripHTML(s string) string

+ func SymbolicWalk(fs afero.Fs, root string, walker filepath.WalkFunc) error

+ func ThemeSet() bool

+ func ToLowerMap(m map[string]interface{})

+ func TotalWords(s string) int

+ func TruncateWordsByRune(words []string, max int) (string, bool)

+ func TruncateWordsToWholeSentence(s string, max int) (string, bool)

+ func Uglify(in string) string

+ func UniqueStrings(s []string) []string

+ func WordCount(s string) map[string]int

+ func WriteToDisk(inpath string, r io.Reader, fs afero.Fs) (err error)

+ type Blackfriday struct

+ AngledQuotes bool

+ Extensions []string

+ ExtensionsMask []string

+ Fractions bool

+ HrefTargetBlank bool

+ LatexDashes bool

+ PlainIDAnchors bool

+ SmartDashes bool

+ Smartypants bool

+ SourceRelativeLinksEval bool

+ SourceRelativeLinksProjectFolder string

+ TaskLists bool

+ func NewBlackfriday(c ConfigProvider) *Blackfriday

+ type ConfigProvider interface

+ Get func(key string) interface{}

+ GetBool func(key string) bool

+ GetInt func(key string) int

+ GetString func(key string) string

+ GetStringMap func(key string) map[string]interface{}

+ GetStringMapString func(key string) map[string]string

+ func Config() ConfigProvider

+ type DistinctLogger struct

+ func NewDistinctErrorLogger() *DistinctLogger

+ func NewDistinctFeedbackLogger() *DistinctLogger

+ func (l *DistinctLogger) Printf(format string, v ...interface{})

+ func (l *DistinctLogger) Println(v ...interface{})

+ type FileResolverFunc func(ref string) (string, error)

+ type HugoHTMLRenderer struct

+ func (renderer *HugoHTMLRenderer) BlockCode(out *bytes.Buffer, text []byte, lang string)

+ func (renderer *HugoHTMLRenderer) Image(out *bytes.Buffer, link []byte, title []byte, alt []byte)

+ func (renderer *HugoHTMLRenderer) Link(out *bytes.Buffer, link []byte, title []byte, content []byte)

+ func (renderer *HugoHTMLRenderer) List(out *bytes.Buffer, text func() bool, flags int)

+ func (renderer *HugoHTMLRenderer) ListItem(out *bytes.Buffer, text []byte, flags int)

+ type HugoMmarkHTMLRenderer struct

+ func (renderer *HugoMmarkHTMLRenderer) BlockCode(out *bytes.Buffer, text []byte, lang string, caption []byte, subfigure bool, ...)

+ type Language struct

+ Lang string

+ LanguageName string

+ Title string

+ Weight int

+ func NewDefaultLanguage() *Language

+ func NewLanguage(lang string) *Language

+ func (l *Language) Get(key string) interface{}

+ func (l *Language) GetBool(key string) bool

+ func (l *Language) GetInt(key string) int

+ func (l *Language) GetString(key string) string

+ func (l *Language) GetStringMap(key string) map[string]interface{}

+ func (l *Language) GetStringMapString(key string) map[string]string

+ func (l *Language) Params() map[string]interface{}

+ func (l *Language) SetParam(k string, v interface{})

+ func (l *Language) String() string

+ type Languages []*Language

+ func NewLanguages(l ...*Language) Languages

+ func (l Languages) Len() int

+ func (l Languages) Less(i, j int) bool

+ func (l Languages) Swap(i, j int)

+ type LinkResolverFunc func(ref string) (string, error)

+ type PathSpec struct

+ func CurrentPathSpec() *PathSpec

+ func NewPathSpecFromConfig(config ConfigProvider) *PathSpec

+ func (p *PathSpec) AbsURL(in string, addLanguage bool) string

+ func (p *PathSpec) MakePath(s string) string

+ func (p *PathSpec) MakePathSanitized(s string) string

+ func (p *PathSpec) PaginatePath() string

+ func (p *PathSpec) RelURL(in string, addLanguage bool) string

+ func (p *PathSpec) URLPrep(in string) string

+ func (p *PathSpec) URLize(uri string) string

+ func (p *PathSpec) URLizeAndPrep(in string) string

+ func (p *PathSpec) UnicodeSanitize(s string) string

+ type RenderingContext struct

+ Config *Blackfriday

+ ConfigProvider ConfigProvider

+ Content []byte

+ DocumentID string

+ DocumentName string

+ FileResolver FileResolverFunc

+ LinkResolver LinkResolverFunc

+ PageFmt string

+ RenderTOC bool

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