slate

Documentation

Index

• Constants
• func Extract(target string, overwrite bool, components ...string) error
• func ListBundled(w io.Writer)
• func Slateficate(src string, target *afero.Afero, params Params) error
• type ContentParams
  • func (p *ContentParams) StyleCSS() string
• type Params

Constants

const GoSlateVersion = "v1.0.1"

const SlateVersion = "v2.3.1"

Functions

func Extract

func Extract(target string, overwrite bool, components ...string) error

Extract embedded slate components to target

func ListBundled

func ListBundled(w io.Writer)

func Slateficate

func Slateficate(src string, target *afero.Afero, params Params) error

Go Slate!

Types

type ContentParams

type ContentParams struct {
	Title      string   `yaml:"title,omitempty"`
	Search     bool     `yaml:"search,omitempty"`
	Highlight  string   `yaml:"highlight_style,omitempty"`
	Langs      []string `yaml:"language_tabs,omitempty"`
	TocFooters []string `yaml:"toc_footers,omitempty"`
	Includes   []string `yaml:"includes,omitempty"`
	Style      string   `yaml:"style,omitempty"`
	Logo       string   `yaml:"logo,omitempty"`
	RTLEnabled bool     `yaml:"enable_rtl,omitempty"`
	HTMLHead   string   `yaml:"html_head,omitempty"`
}

func (*ContentParams) StyleCSS

func (p *ContentParams) StyleCSS() string

type Params

type Params struct {
	MinifyHTML bool   // produce compact HTML
	MinifyJS   bool   // minify Javascript
	MinifyCSS  bool   // produce compact CSS
	StyleFile  string // load SCSS overrides
	LogoFile   string // use this logo (which should be located in images/ directory)
	Search     *bool  // if nil, use the default from index.html.md preamble
	RTL        *bool  // Right-to-Left CSS, if nil, use the default from index.html.md preamble
}

Configuration