Using Hugo as a library?

pauldotknopf · March 4, 2018, 2:36am

I have to integrate static site generation into a larger product.

Can I reference Hugo as a lib? Is it designed for it?

Doing so, can I add custom shortcode plugins?

pauldotknopf · March 4, 2018, 8:29am

Update, it is possible.

Here is the code I got to start rolling.

github.com

pauldotknopf/docgen/blob/97350f70a10903b5e628f9e1116fa719f588a69a/main.go

package main

import (
	"fmt"
	"io/ioutil"
	"log"
	"os"

	"github.com/gohugoio/hugo/deps"
	"github.com/gohugoio/hugo/helpers"
	"github.com/gohugoio/hugo/hugofs"
	"github.com/gohugoio/hugo/hugolib"
	"github.com/gohugoio/hugo/source"
	jww "github.com/spf13/jwalterweatherman"
)

func main() {

	var cfg = &deps.DepsCfg{}
	osFs := hugofs.Os

This file has been truncated. show original

It is rough, but I have proven it is feasible.

I need to implement dynamic pages based off of a complicated Go struct, so I am going to use the afero.Fs stuff to “fake” files that don’t really exist.

bep · March 4, 2018, 10:22am

It is not built to be used as a library, but it can be done.

I would recommend to use the CLI:

github.com

bep/html5up-to-hugo/blob/master/main.go#L286




	_, err = toml.DecodeReader(f, &conf)
	if err != nil {
		return conf, err
	}


	return conf, err


}


func buildHugoSite(source, destination, theme string) error {
	defer commands.Reset()


	destination = path.Join(destination, "theme", theme)


	baseURL := fmt.Sprintf("http://localhost:1313/theme/%s/", theme)
	flags := []string{"--quiet", "--gc",
		fmt.Sprintf("--baseURL=%s", baseURL),
		fmt.Sprintf("--source=%s", source),
		fmt.Sprintf("--destination=%s", destination),
		fmt.Sprintf("--theme=%s", theme)}

pauldotknopf · March 4, 2018, 10:26am

I need the ability to provide dynamic pages. So, I am trying to hack at the aferofs stuff, before calling build, to provide these pages.

The struct is complicated as well, and don’t want to generate files before hugo gets run.

Would you recommend another approach?

bep · March 4, 2018, 10:38am

I would do it without Hugo.

pauldotknopf · March 4, 2018, 10:52am

Generate the pages before I run Hugo?

What about providing a single json feed to Hugo?

Like this: https://github.com/SchumacherFM/hugo/commit/0f32b3720e7affc5670fd207eafdd6891db783ae

Topic		Replies	Views
Using Hugo as part of another Go application dev	0	601	March 31, 2022
Go Plugins to extend Hugo support	3	1176	November 10, 2021
Is it possible to use Hugo as library? support	1	738	May 3, 2017
Building hugo for purposes of contribution doesn't work (deps not installed?) dev	11	1097	December 15, 2022
Hugo 0.56.0 Released! Announcements	9	1416	August 6, 2019

Using Hugo as a library?

Related topics