content

package

v0.0.0-...-4d8c88f Latest Latest Go to latest Published: Aug 10, 2021 License: MPL-2.0 Imports: 8 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/gzuidhof/starlit

Links

Open Source Insights

Documentation ¶

Index ¶

type Page
- func ReadPageFile(path string, file afero.File) (Page, error)
- func (p *Page) LinkTitle() string
- func (p *Page) Title() string
type PageType
- func DetermineContentFileType(filename string) PageType

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Page ¶

type Page struct {
	Type    PageType
	Content []byte

	FrontMatter               *viper.Viper
	ContentWithoutFrontmatter []byte

	Path                     string
	PathWithoutExtension     string
	Filename                 string
	FilenameWithoutExtension string

	// Used to determine the order of pages
	Weight int
}

func ReadPageFile ¶

func ReadPageFile(path string, file afero.File) (Page, error)

func (*Page) LinkTitle ¶

func (p *Page) LinkTitle() string

func (*Page) Title ¶

func (p *Page) Title() string

type PageType ¶

type PageType string

const (
	Markdown    PageType = "markdown"
	JetTemplate PageType = "jet"
	HTML        PageType = "html"
	Notebook    PageType = "notebook"
	Unknown     PageType = "unknown"
)

func DetermineContentFileType ¶

func DetermineContentFileType(filename string) PageType

Source Files ¶

View all Source files

page.go

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