staticweb

Static Web

Compile HTML and MD template files together into a static html website.

Installation

# install the go module
go get github.com/tkdeng/staticweb

# or install the binary
git clone https://github.com/tkdeng/staticweb.git &&\
cd staticweb &&\
make install &&\
cd ../ && rm -r staticweb

# install into /usr/bin
make install

# install locally (with dependencies)
make local

# build without dependency installation
make build

# install dependencies
make deps

# uninstall htmlc
make clean

Golang Usage

import (
  "github.com/tkdeng/staticweb"
)

func main(){
  // compile directory
  err := staticweb.Compile("./src", "./dist")

  // compile specific page/directory
  err := staticweb.Compile("./src", "./dist", "/about")

  // compile and watch for file changes
  fileWatcher := staticweb.Live("./src", "./dist", func(err error){
    // handle errors
    fmt.Println(err)
  })
}

Binary Usage

staticweb ./src --out="./dist"

# optional: run live server
staticweb ./src 3000
staticweb ./src --live # default port: 3000