Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 1.7 KB

README.md

File metadata and controls

46 lines (28 loc) · 1.7 KB
Raw

! WIP -NON FUNCTIONAL AT THIS TIME

Go-Static

go-static 1

Pupose

Go-Static is a simple, general purpose Markdown to HTML static site generation tool written in GO and utilizing Templ.

The creation of Go-Static is strictly for my education and usage in my own personal website project. Primarily for blog content. Markdown has a nice, simple and concise syntax and allows for great creativity in writing. It is a great fit for simple pages, blogs, news articles, general information pages, etc.

There are many static site generators which have greater functionality, and if you need to adhear to certain specifications I would advise checking out other projects for now.

Projects like: - Makdown-it - Goldmark - Golang-Commonmark - etc...

TechStack

Mechanism

Go-Static is a simple lexical anaylsis and parser that creates an AST2 and renders HTML out.

  1. The lexer steps through the file, creates, and organizes Tokens into Tree Nodes.

  2. The Tree Nodes are then stepped through and used to populate the HTML template backed by TEMPL.

  3. The template is then rendered into output comprised of an HTML code file that follows site guidelines for style and functionality.

  4. Finally the file is distributed to the website directory to be used immediately in hosting.

Build - Quick Start

Details to come

Contributing

Contribution details to come.

Footnotes

  1. Go-Static Illustration by Eric Trinque. ↩

  2. Abstract Syntax Tree - Wiki ↩