Output formats - any help yet?

Raymond_Camden 2017-05-17 18:57:04 UTC #1

Back when output formats (http://gohugo.io/extras/output-formats/) I tried my best to grok the docs but am still failing to get how this is used in the real world. I'm starting with what I assume is a simple demo. I want to build a page to output JSON.

I first tried this:

{
	"url":"/feed/json",
	"outputs":["json"]
}

Hello2xxkjxczjkl

Which I recognize isn't valid JSON (the stuff at the bottom), but I assumed that hitting /feed/json would return the content by itself with no layout. However, it still uses the main site layout. So am I just using this feature wrong?

As a follow up, obviously I don't want hard coded JSON, but something dynamic. Hugo still does not want you to write code in your /content folder, correct? So I'd need to build a shortcode perhaps and put the logic there?

bep 2017-05-17 20:16:52 UTC #2

Have a look at this theme's example site. It defines the outputs on a site level (i.e. in config.toml), but it is also do specify this on page level i.e. in page frontmatter.

github.com

vjeantet/hugo-theme-docdock/blob/master/exampleSite/config.toml#L19


[params]
editURL = "https://github.com/vjeantet/hugo-theme-docdock/edit/master/exampleSite/content/"
noHomeIcon = false # default is false
noSearch = false # default is false
showVisitedLinks = true # default is false
unfoldedMenus = ["start"] # set menu identifiers which should be displayed unfolded  
# themeVariant = "green" # choose theme variant "green", "gold" , "blue" (default)




[outputs]
home = [ "HTML", "RSS", "JSON"]




[[menu.shortcuts]]
pre = "<h3>More</h3>"
name = "<i class='fa fa-github'></i> Github repo"
identifier = "ds"
url = "https://github.com/vjeantet/hugo-theme-docdock"
weight = 1


[[menu.shortcuts]]

If you look at the above, it specifices that it wants the home page rendered as HTML, RSS and JSON, and then provides templates for the JSON homepage:

github.com

vjeantet/hugo-theme-docdock/blob/master/layouts/index.json

[{{ range $index, $page := .Site.Pages }}
{{- if ne $page.Type "json" -}}
{{- if and $index (gt $index 0) -}},{{- end }}
{
	"uri": "{{ $page.Permalink }}",
	"title": "{{ htmlEscape $page.Title}}",
	"tags": [{{ range $tindex, $tag := $page.Params.tags }}{{ if $tindex }}, {{ end }}"{{ $tag| htmlEscape }}"{{ end }}],
	"description": "{{ htmlEscape .Description}}",
	"content": "{{ range $i, $words := $page.PlainWords }}{{ $words | htmlEscape  }} {{ end }}"
}
{{- end -}}
{{- end -}}]

Raymond_Camden 2017-05-17 20:40:09 UTC #3

So given a new page, let's say foo.md. If I specify JSON as an output, and only json, should it expect to find /layouts/foo.json to handle rendering it?

Raymond_Camden 2017-05-17 20:42:38 UTC #4

So I tried that since - obviously- it takes about 2 seconds. Given a file under content with the name jsonfeed.md, and this source:

{
	"url":"/feed/json",
	"outputs":["json"]
}

Hello2xxkjxczjkl

I then added layouts/jsonfeed.json, and as far as I can tell, it's not rendering right.

bep 2017-05-18 06:54:19 UTC #5

No, but again, this is well documented and I have given you a concrete example. Re. the templates, the behaviour mimics that of the HTML output format. And you would never have expected Hugo to have a 1:1 mapping between the Markdown pages and the templates?

Raymond_Camden 2017-05-18 11:07:30 UTC #6

I apologize as I'm simply having difficultly mapping the example you linked to to the more general concept of how this is supposed to work. So given my page, let's say /content/foo.md, where my intent is for it to output JSON, it sounds like you are saying I'm perhaps missing the layout front matter to tell it what layout to use. Is that right? But I had thought that this new feature supported the layout automatically.

I think my issue is, given /content/X,md, how do I get it to run a layout that will be just JSON and nothing more. Using the outputs front matter is required, but I don't know the next step.

bep 2017-05-18 13:09:17 UTC #7

You need a template. You can either be specific (by setting the layout=somelayout in frontmatter), but just to get something working I would suggest just adding:

layouts/_default/single.json

Hugo's template handling is a core feature to understand, even if your output format is just plain old HTML.

Raymond_Camden 2017-05-18 13:42:34 UTC #8

I think my confusion was in thinking it was more automatic - if that makes sense. I'll dig and report back.

Raymond_Camden 2017-05-18 14:05:26 UTC #9

Ok, so I've made some progress. I created /layouts/_default/single.json. With my content page saying it outputs just JSON, my assumption is that it would load this template automatically. Now when I run my request, I don't get the regular HTML output, I get absolutely nothing. So I think I'm on the right track, but can you explain why nothing is being shown?

My template is just this for now:

hELLO
{{ .Content }}

which I know isn't valid JSON output, but for now I just want to see my output - I'll make it real later.

bep 2017-05-18 14:20:34 UTC #10

What do you mean shown? It may be good to just run hugo and see what files gets built into /public.

Raymond_Camden 2017-05-18 14:31:36 UTC #11

And like magic - I finally got it. Running the output helped flesh out where the file was being created. I think one of the biggest issues I have with Hugo is that I think of layouts as always being wrappers, not actually generating page content as well. Thank you for being patient. My goal is to generate a new template for this: https://jsonfeed.org/

When I get this working, I'll blog, and post back here. I'd love your opinion on my solution (in case I do something stupid

deitcher 2017-07-13 16:00:37 UTC #12

I have not been able to get it to work. I have a simple search index I am trying to create with json. My file is at content/json/search.json (same if I do search.md or put it at /content/search.json (or search.md), it just doesn't appear to run it through the template.

The search.json is simple:

---
outputs: ["json"]
layout: "json"
url: /search.json
---

And yet when I try to view the page, I see just the raw content, i.e. the front matter.

I tried putting the layout in layouts/json/single.json, in layouts/_default/single.json (and tried for list.json as well).

Also interestingly, it completely ignores url: /search.json , placing it under whatever directory I have it at the moment.

@Raymond_Camden, how did you get it? Which files did you place where?

deitcher 2017-07-13 17:48:21 UTC #13

One step up, it seems to generate it as json/index.html and json/index.xml, rather than /search.json.

So:

It isn't running it through json/single.json but rather _default/single.html
It isn't respecting the url: to make it a single json page

deitcher 2017-07-13 17:51:29 UTC #14

OK, ignore, idiot question. I was using layout: instead of type:. Doh!

Raymond_Camden 2017-07-14 23:04:21 UTC #15

Sorry for the delay - I was on vacation. I wrote up my solution here:

I still feel like this support needs doc help as I think I had to pretty much guess my way to a solution.