Neko is a lightweight, fast, and extensible static site generator (SSG) written in Go. It aims to provide a simple yet powerful alternative to more complex SSG options like Hugo or Jekyll, focusing on speed and ease of configuration. The core philosophy revolves around using data files (YAML, JSON, TOML) to drive content generation, combined with Go templates for rendering. It's particularly well-suited for blogs, documentation sites, and simple websites where performance is a priority.
The repository's structure is relatively straightforward. The `cmd/neko` directory contains the main application logic for building the site. `internal` houses the core functionalities like template parsing, data loading, and file system operations. `pkg` contains reusable components that could potentially be used in other projects. Crucially, Neko doesn't enforce a rigid directory structure for content; it's designed to be flexible, allowing users to organize their content in a way that makes sense for their project. This is achieved through configuration files that define data sources and template mappings.
A key feature of Neko is its data-driven approach. Content isn't directly embedded within templates. Instead, data is loaded from files (YAML, JSON, TOML are supported out-of-the-box, with potential for extension) and then passed to the templates for rendering. This separation of content and presentation makes it easier to manage and update content without modifying the templates themselves. The configuration file specifies where to find these data files and how they should be processed. Neko also supports front matter within Markdown files, allowing for metadata to be associated with each piece of content.
Templating is handled using Go's built-in `html/template` package, providing a familiar and powerful templating engine. This allows for complex logic and dynamic content generation within the templates. Neko provides helper functions within the template context to simplify common tasks like URL generation, date formatting, and content filtering. The templates themselves are organized in a directory specified in the configuration file, and Neko recursively searches this directory for `.html` files.
Extensibility is another important aspect of Neko. While it provides a solid foundation out of the box, it's designed to be easily extended through custom functions and shortcodes. Users can define their own Go functions and make them available within the template context, allowing for highly customized content generation. Shortcodes, which are reusable snippets of HTML or template code, can also be defined to simplify the creation of common elements. The project is actively maintained and welcomes contributions, suggesting a growing community and ongoing development. Overall, Neko offers a compelling option for developers seeking a fast, flexible, and easy-to-use static site generator.
