ebiten/_docs/gen.go

// Copyright 2014 Hajime Hoshi
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// +build ignore

package main

import (
	"github.com/google/go-github/github"
	"html/template"
	"io/ioutil"
	"log"
	"os"
	"path/filepath"
)

const (
	outputPath   = "public/index.html"
	readMePath   = "../readme.md"
	templatePath = "index_tmpl.html"
)

// TODO: License should be on another file
const license = `Copyright 2014 Hajime Hoshi

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.`

func parseMarkdown(path string) (string, error) {
	md, err := ioutil.ReadFile(path)
	if err != nil {
		return "", err
	}

	client := github.NewClient(nil)
	html, _, err := client.Markdown(string(md), nil)
	if err != nil {
		return "", err
	}

	return html, nil
}

func comment(text string) template.HTML {
	// TODO: text should be escaped
	return template.HTML("<!--" + text + "-->")
}

func safeHTML(text string) template.HTML {
	return template.HTML(text)
}

func main() {
	f, err := os.Create(outputPath)
	if err != nil {
		log.Fatal(err)
	}
	defer f.Close()

	// Parse readme.md
	readme, err := parseMarkdown(readMePath)
	if err != nil {
		log.Fatal(err)
	}

	funcs := template.FuncMap{
		"comment":  comment,
		"safeHTML": safeHTML,
	}
	name := filepath.Base(templatePath)
	t, err := template.New(name).Funcs(funcs).ParseFiles(templatePath)
	if err != nil {
		panic(err)
	}
	data := map[string]string{
		"License": license,
		"ReadMe":  readme,
	}
	if err := t.Funcs(funcs).Execute(f, data); err != nil {
		log.Fatal(err)
	}
}