{"id":25304811,"url":"https://github.com/mikogs/spidey","last_synced_at":"2025-07-31T05:10:19.822Z","repository":{"id":204002763,"uuid":"710866093","full_name":"mikogs/spidey","owner":"mikogs","description":"Tiny website generator","archived":false,"fork":false,"pushed_at":"2024-12-18T20:57:08.000Z","size":24,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-07T04:19:31.476Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mikogs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-27T15:49:10.000Z","updated_at":"2024-12-18T20:56:48.000Z","dependencies_parsed_at":null,"dependency_job_id":"dfb3837f-0ea0-4fc9-b9dc-587a6898c178","html_url":"https://github.com/mikogs/spidey","commit_stats":null,"previous_names":["bitsnops/spidey","mikogs/spidey","gasior-dev/spidey","nicholasgasior/spidey","mikolajgs/spidey"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/mikogs/spidey","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikogs%2Fspidey","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikogs%2Fspidey/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikogs%2Fspidey/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikogs%2Fspidey/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mikogs","download_url":"https://codeload.github.com/mikogs/spidey/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikogs%2Fspidey/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267989071,"owners_count":24177020,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-31T02:00:08.723Z","response_time":66,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-13T08:33:16.137Z","updated_at":"2025-07-31T05:10:19.633Z","avatar_url":"https://github.com/mikogs.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# spidey\n[![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)\n\nTiny static website generator\n\nSpidey is a tool designed to create static websites from HTML and Markdown snippets.  The tool\nenables the construction of websites that include both pages and posts.  It utilizes predefined layouts\nand snippets—like headers, footers, and post lists—to structure content.  You can write pages and posts\nin either pure HTML or Markdown, which Spidey then seamlessly assembles into a complete static website.\n\nHave a butcher's at `src` and `dist` in the `examples` directory to see it in action.\n\nSpidey has been rapidly written to replace other tool.  It contains minimal functionality, just to fulfill\nrequirement of creating simple websites.  Hence, some bits in the code are hardcoded, and there might be\nmany TODOs.\n\n### Building\nRun `go build` in the root directory to build the binary.\n\n### Running\nSpidey has one command called `generate` which takes two arguments:\n* source directory where the website configuration, layouts, pages, posts and other contents are located\n* destination directory where HTML files should be generated, and this one has to be empty\n\n#### Quick start\nCreate any empty directory where HTML files should be written, eg. `/tmp/spidey-generated-files` and run\nthe following command from root of this repository:\n\n    spidey generate -s $(pwd)/examples/src -d /tmp/spidey-generated-files\n\n#### Live preview\nSpidey does not allow live preview of the website yet.  However, you can use nginx docker container that\nwould run in the background and serve the pages.\n\nTo set things up, open the `_config.yml` file in an editor and change the value of `baseurl` to \n`http://localhost:8080` (or any other port).\nNext, start nginx container and mount destination directory to it (place where HTML files are generated):\n\n    docker run --name some-nginx -p 8080:80 -v /tmp/spidey-generated-files:/usr/share/nginx/html:ro -d nginx\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikogs%2Fspidey","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmikogs%2Fspidey","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikogs%2Fspidey/lists"}