Provide example usage for other static site generatos

[mre]

We need to add some usage examples for

• Jekyll
• Hugo
• Cobalt

For the most part, this means showing how to create an index.json as shown in /fixtures/index.json from this repo.

For example, I'm using the following template file for zola:

{% set section = get_section(path="_index.md") %}

[
{%- for post in section.pages -%}
{
"title": {{ post.title | safe | striptags | json_encode }},
"url": {{ post.permalink | safe | json_encode }},
"body": {{ post.content | safe | striptags | json_encode }}
}{% if not loop.last %},{% endif %}
{%- endfor -%}
]

If someone wants to tackle this, feel free to add a comment here so that others know you're working on this. You can also create a pull request straight away.

[mre]

Jekyll example: https://learn.cloudcannon.com/jekyll/output-json/

[machbio]

• Pelican

Pelican

Pelican has a plugin called Tipue Search (https://github.com/getpelican/pelican-plugins/tree/master/tipue_search) which uses a javascript variable json similar to the tinysearch - it would be interesting to see if tinysearch is scalable for a medium sized blog

[Lusitaniae]

Hugo - Seems they usually build external tools to generate search indexes, see https://gohugo.io/tools/search/

To do it natively you build a template and adding it as "export" format

cat layouts/_default/baseof.json.json

[
	{{ block "response" .}}{{ end }}
]

cat layouts/_default/list.json.json

{{ define "response" }}
[
    {{ range $index, $e := .Data.Pages }}
    {{ if $index }}, {{ end }}{{ .Render "item" }}
    {{ end }}
]
{{ end }}

cat layouts/_default/item.json.json

	{
	    "title": "{{ .Title }}",
	    "url" : "{{ .Permalink }}",
	    "body" : "{{  .PlainWords  }}"
	}

cat config.toml

...

[outputs]
    home = ["json"] # Everything

File will be in public/index.json

See https://forestry.io/blog/build-a-json-api-with-hugo/

[mre]

Thanks @Lusitaniae,
added your tutorial at https://github.com/mre/tinysearch/blob/master/howto/hugo.md.

[mre]

Anyone wants to tackle Jekyll or Pelican?

[lord-re]

To implement it in Hugo, you can have a simpler setup :

layout/_default/list.json.json

[
{{ range $index , $e := .Site.RegularPages }}{{ if $index }}, {{end}}{{ dict "title" .Title "url" .Permalink "body" .Plain | jsonify }}{{end}}
]

and config.toml

[outputs]
home = ["html","json","rss"]

( if you only put json, you won't build your site and your rss anymore).

It's a bit simpler and doesn't break the site.

[mre]

Nice @lord-re. Much appreciated!
Can you edit the file here and create a pull request?
I'd merge it on the spot.

[Ninjani]

Hello! Figured this out for Pelican to add to our website.

You need a templates/json.html file with:

[
{%- for article in articles -%}
{% if article.status != "draft" %}
{
"title": {{ article.title | striptags | tojson | safe }},
"url": {{ article.url | tojson | safe }},
"body": {{ article.content | striptags | tojson | safe }}
}{% if not loop.last %},{% endif %}
{% endif %}
{%- endfor -%}
]

and a json.md file in your content/pages folder with

Title: JSON
Template: json
Slug: json

Then, after running pelican content, tinysearch --path output output/pages/json.html builds the index.

Shall I make a PR?

[mre]

Nice! PR would be very welcome. 😊

[dertuxmalwieder]

To implement it in Hugo, you can have a simpler setup

Doing that generates a public/index.json which contains an empty list. Why?

[mre]

Sorry for the late response. I don't know what might cause this.
Maybe @lord-re has an idea. If so, please post below and we can reopen.