statping: github.com/hunterlong/statping/source Index | Examples | Files

package source

import "github.com/hunterlong/statping/source"

Package source holds all the assets for Statping. This includes CSS, JS, SCSS, HTML and other website related content. This package uses Rice to compile all assets into a single 'rice-box.go' file.

Required Dependencies

- rice -> https://github.com/GeertJohan/go.rice - sass -> https://sass-lang.com/install

Compile Assets

To compile all the HTML, JS, SCSS, CSS and image assets you'll need to have rice and sass installed on your local system.

sass source/scss/base.scss source/css/base.css
cd source && rice embed-go

More info on: https://github.com/hunterlong/statping

Code generated by go generate; DO NOT EDIT. This file was generated by robots at 2019-03-16 15:39:30.237389 -0700 PDT m=+0.779058438

This contains the most recently Markdown source for the Statping Wiki.

Index

Examples

Package Files

doc.go source.go wiki.go

Variables

var (
    CssBox  *rice.Box // CSS files from the 'source/css' directory, this will be loaded into '/assets/css'
    ScssBox *rice.Box // SCSS files from the 'source/scss' directory, this will be loaded into '/assets/scss'
    JsBox   *rice.Box // JS files from the 'source/js' directory, this will be loaded into '/assets/js'
    TmplBox *rice.Box // HTML and other small files from the 'source/tmpl' directory, this will be loaded into '/assets'
    FontBox *rice.Box // HTML and other small files from the 'source/tmpl' directory, this will be loaded into '/assets'
)
var CompiledWiki = []byte("" /* 70908 byte string literal not displayed */)

CompiledWiki contains all of the Statping Wiki pages from the Github Wiki repo.

func Assets Uses

func Assets()

Assets will load the Rice boxes containing the CSS, SCSS, JS, and HTML files.

func CompileSASS Uses

func CompileSASS(folder string) error

CompileSASS will attempt to compile the SASS files into CSS

func CopyAllToPublic Uses

func CopyAllToPublic(box *rice.Box, folder string) error

CopyAllToPublic will copy all the files in a rice box into a local folder

func CopyToPublic Uses

func CopyToPublic(box *rice.Box, folder, file string) error

CopyToPublic will create a file from a rice Box to the '/assets' directory

func CreateAllAssets Uses

func CreateAllAssets(folder string) error

CreateAllAssets will dump HTML, CSS, SCSS, and JS assets into the '/assets' directory

func DeleteAllAssets Uses

func DeleteAllAssets(folder string) error

DeleteAllAssets will delete the '/assets' folder

func HelpMarkdown Uses

func HelpMarkdown() string

HelpMarkdown will return the Markdown of help.md into HTML

func MakePublicFolder Uses

func MakePublicFolder(folder string) error

MakePublicFolder will create a new folder

func OpenAsset Uses

func OpenAsset(folder, file string) string

OpenAsset returns a file's contents as a string

Code:

OpenAsset("js", "main.js")

func SaveAsset Uses

func SaveAsset(data []byte, folder, file string) error

SaveAsset will save an asset to the '/assets/' folder.

Code:

data := []byte("alert('helloooo')")
SaveAsset(data, "js", "test.js")

func UsingAssets Uses

func UsingAssets(folder string) bool

UsingAssets returns true if the '/assets' folder is found in the directory

Package source imports 7 packages (graph) and is imported by 4 packages. Updated 2019-03-19. Refresh now. Tools for package owners.