Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sea-grass/goku
A Static Site Generator written in Zig.
https://github.com/sea-grass/goku
markdown static-site-generator yaml zig
Last synced: 3 days ago
JSON representation
A Static Site Generator written in Zig.
- Host: GitHub
- URL: https://github.com/sea-grass/goku
- Owner: sea-grass
- License: mit
- Created: 2024-08-06T20:30:30.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-16T22:34:41.000Z (11 days ago)
- Last Synced: 2024-09-20T14:08:22.276Z (8 days ago)
- Topics: markdown, static-site-generator, yaml, zig
- Language: Zig
- Homepage: http://christophergrass.com/goku/
- Size: 625 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Goku
Goku is a Static Site Generator written in Zig.
## Introduction
A static site generator (SSG) is typically run on some input source to produce a folder of html files, suitable for hosting on any HTTP server. Goku aims to be a SSG that can operate on a variety of input sources to generate static sites of up to hundreds of thousands of pages.
## Notice
> [!NOTE]
> Goku is in its early stages. The roadmap for features is prioritized on an as-needed basis. If you want to use Goku but it's lacking a key feature you need, feel free to check out the [contributing](#contributing) section of the readme.
## Requirements
- Officially supported Zig: `Zig 0.13.0-dev.351+64ef45eb0` (you can get it from the [Zig Releases page](https://ziglang.org/download/))
## Installation
Use Zig to build the application binary. With a shell open in this project's directory:
```
zig build -Doptimize=ReleaseSafe
```
The goku binary will be available at `zig-out/bin/goku`.
## Usage
See [the docs](./site/pages/docs/site.md) on how to scaffold your first Goku site.
Once you've set up your site, you can use goku to build it:
```
goku site -o build
```
In the above example, Goku will scan `site/pages` recursively for all `.md` files, parse their yaml frontmatter for a `slug`, and then place the built sites into the `build` folder according to each page's `slug`. It will provide a build summary with the time elapsed and the source and destination directories.
Once you've built the site, you can try previewing it on your local machine using your preferred file server. For example, if you have `python3` on your system, you can try:
```
sh -c 'cd build; python3 -m http.server'
```
## Further Work
In its current form, Goku is very basic. There is no support for theming, asset management, etc. If there's a feature you'd like to see, please open a GitHub issue.
## Contributing
Contributions are welcome, but I do request that if there's no open GitHub issue regarding your ideal change that you open one first! It's likely that I'm already working on the feature, so following this process helps to ensure that we're not spending double the time.
## Bug reports
If you find a bug in the software, please report it using the GitHub issue tracker for this project's repository.