https://github.com/mikogs/spidey

Tiny website generator
https://github.com/mikogs/spidey

Last synced: 10 months ago
JSON representation

Tiny website generator

• Host: GitHub
• URL: https://github.com/mikogs/spidey
• Owner: mikogs
• License: bsd-2-clause
• Created: 2023-10-27T15:49:10.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-18T20:57:08.000Z (over 1 year ago)
• Last Synced: 2025-04-07T04:19:31.476Z (about 1 year ago)
• Language: Go
• Size: 23.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# spidey

[![Go Reference](https://pkg.go.dev/badge/github.com/mikolajgs/spidey.svg)](https://pkg.go.dev/github.com/mikolajgs/spidey) [![Go Report Card](https://goreportcard.com/badge/github.com/mikolajgs/spidey)](https://goreportcard.com/report/github.com/mikolajgs/spidey) ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/mikolajgs/spidey?sort=semver)

Tiny static website generator

Spidey is a tool designed to create static websites from HTML and Markdown snippets.  The tool

enables the construction of websites that include both pages and posts.  It utilizes predefined layouts

and snippets—like headers, footers, and post lists—to structure content.  You can write pages and posts

in either pure HTML or Markdown, which Spidey then seamlessly assembles into a complete static website.

Have a butcher's at `src` and `dist` in the `examples` directory to see it in action.

Spidey has been rapidly written to replace other tool.  It contains minimal functionality, just to fulfill

requirement of creating simple websites.  Hence, some bits in the code are hardcoded, and there might be

many TODOs.

### Building

Run `go build` in the root directory to build the binary.

### Running

Spidey has one command called `generate` which takes two arguments:

* source directory where the website configuration, layouts, pages, posts and other contents are located

* destination directory where HTML files should be generated, and this one has to be empty

#### Quick start

Create any empty directory where HTML files should be written, eg. `/tmp/spidey-generated-files` and run

the following command from root of this repository:

    spidey generate -s $(pwd)/examples/src -d /tmp/spidey-generated-files

#### Live preview

Spidey does not allow live preview of the website yet.  However, you can use nginx docker container that

would run in the background and serve the pages.

To set things up, open the `_config.yml` file in an editor and change the value of `baseurl` to 

`http://localhost:8080` (or any other port).

Next, start nginx container and mount destination directory to it (place where HTML files are generated):

    docker run --name some-nginx -p 8080:80 -v /tmp/spidey-generated-files:/usr/share/nginx/html:ro -d nginx