Skip to content

wejeus/tindra

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Tindra - the glimmering site generator!

Like Rubys Jekyll but for Go! Project is in initial planning and hacking phase, stay tuned! Try it out by running:

go run tindra.go --target <site folder>

Should output a generated site in /build dir

Special folders

All files and folders in site root are copied verbatim except for a few that are special and one that is allways ignored (build/, config.yml). Files in root are parsed.

<site>/media		- content specific media (media used in posts)
<site>/css

<site>/includes		- snippets that can be included in other places (refer to an include by its filename). May contain subfolders.
<site>/layouts
<site>/posts

404.html
index.html
favicon.png
config.yml

Order of Execution

  • Templates are applied last after page have been generated by including includes and applying layouts.
  • Most recently set data entry is used for variables (that is a frontmatter specifying title in both layout and post the post title is used)

Dependency Graph

Includes are static and nothing can be inserted Layouts can use other layouts. Posts can use layouts

API

Pre-processing

Tindra relies on convention over configuration for many of its setttings. Use special folders for content.

Include files: {% include sidebar.html %} For layouts: {% content %} In posts: accesss variables using golang templates

Post

All blog post files must begin with YAML front-matter. That is the first paragraph and contains a Yaml header. The header affects the rendering of the post.

---
title: "My post title" // if not set uses filename as title
layout: "layout.html"  // if not set just outputs parsed markdown
---

Roadmap

  • Add support for file inclusion
  • Add ability run as stand alone webserver
  • Add filesytem watchers
  • Add support for plugins such as Disqus
  • Generation of feed.xml

About

Static site generator

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages