stopgo

README

stopgo

Static site / pdf generator for your resume/cv, written in go

stopgo = resume. Get it?

Remember when it was cool to write your resume in LaTeX? Use golang & stopgo instead!

The code takes a resume definition in JSON format and generates a PDF and a static website.

Example

• Website: http://johntunison.info
• PDF: http://johntunison.info/John_Tunison_Resume.pdf

Features

• QR code in PDF points to website
• Publish to S3 (with diffing md5 hashes, so it does quick updates)

License & Credits

stopgo is released under the Apache License. If you find it useful, please keep a link back to this page! Patches welcome, of course.

Credits:

• gofpdf - https://code.google.com/p/gofpdf/ (MIT License)
• HTML5 CSS3 site template by Xiaoying Riley at 3rd Wave Media; licensed under CC BY 3.0.

Documentation

Index

• func Build(overlayPath, outputDir string)
• func Publish(localpath, bucketName, awsAccessKey, awsSecretKey string) error
• func RetrieveS3Map(b *s3.Bucket) map[string]string
• func Server()
• func Write(outputName string, resume *Resume)
• type Education
• type Experience
• type Links
• type Resume
  • func Load(path string) *Resume
• type Supplement

Functions

func Build

func Build(overlayPath, outputDir string)

func Publish

func Publish(localpath, bucketName, awsAccessKey, awsSecretKey string) error

func RetrieveS3Map

func RetrieveS3Map(b *s3.Bucket) map[string]string

func Server

func Server()

func Write

func Write(outputName string, resume *Resume)

Types

type Education

type Education struct {
	Institution string
	Degree      string
	StartYear   int
	EndYear     int
}

type Experience

type Experience struct {
	Role       string
	Company    string
	CompanyUrl string
	StartYear  int
	EndYear    int
	Bullets    []string
}

type Links

type Links struct {
	Website    string
	Twitter    string
	Github     string
	GooglePlus string
	LinkedIn   string
}

type Resume

type Resume struct {
	Name                string
	Title               string
	Location            string
	Email               string
	Phone               string
	Summary             string
	History             []Experience
	Supplements         []Supplement
	Links               Links
	Education           []Education
	PdfFilename         string
	GoogleAnalyticsCode string
}

func Load

func Load(path string) *Resume

see https://gobyexample.com/json

type Supplement

type Supplement struct {
	Heading string
	Bullets []string
}