{"id":28906822,"url":"https://github.com/ryu-ryuk/go-webring-generator","last_synced_at":"2026-04-30T07:38:19.259Z","repository":{"id":299455806,"uuid":"1003097654","full_name":"ryu-ryuk/go-webring-generator","owner":"ryu-ryuk","description":" generate static files for yourself using GO","archived":false,"fork":false,"pushed_at":"2025-06-16T17:01:55.000Z","size":23,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-16T17:42:01.829Z","etag":null,"topics":["go","static","static-site","static-site-generator","webring","webring-script"],"latest_commit_sha":null,"homepage":"https://ryu-ryuk.github.io/go-webring-generator/","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ryu-ryuk.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,"zenodo":null}},"created_at":"2025-06-16T16:07:31.000Z","updated_at":"2025-06-16T17:02:46.000Z","dependencies_parsed_at":"2025-06-16T17:52:08.153Z","dependency_job_id":null,"html_url":"https://github.com/ryu-ryuk/go-webring-generator","commit_stats":null,"previous_names":["ryu-ryuk/go-webring-generator"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ryu-ryuk/go-webring-generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryu-ryuk%2Fgo-webring-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryu-ryuk%2Fgo-webring-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryu-ryuk%2Fgo-webring-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryu-ryuk%2Fgo-webring-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ryu-ryuk","download_url":"https://codeload.github.com/ryu-ryuk/go-webring-generator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryu-ryuk%2Fgo-webring-generator/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261143159,"owners_count":23115677,"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","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":["go","static","static-site","static-site-generator","webring","webring-script"],"created_at":"2025-06-21T15:10:00.028Z","updated_at":"2026-04-30T07:38:19.254Z","avatar_url":"https://github.com/ryu-ryuk.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Go Webring Generator\n\nA simple command-line tool written in Go to generate static files for a webring, including navigation links and an index page.\n\n## Features\n\n* Generates `index.html` with a list of webring members.\n* Creates `/rand/index.html` for a random redirect.\n* Generates `/slug/previous/index.html` and `/slug/next/index.html` for each member, redirecting to the previous and next sites in the ring.\n* Uses TOML for data configuration.\n* Supports custom HTML templates.\n\n## Getting Started\n\n### Prerequisites\n\n* Go 1.16 or higher\n\n### Installation\n\n1.  Clone the repository:\n    ```bash\n    git clone https://github.com/ryu-ryuk/go-webring-generator.git\n    cd go-webring-generator\n    ```\n\n2.  Install dependencies:\n    ```bash\n    go mod tidy\n    ```\n\n### Usage\n\n1.  **Configure Members:**\n    Edit `data/members.toml` to define your webring members.\n\n    Example `data/members.toml`:\n    ```toml\n    [[members]]\n    name = \"meowmoewoow\"\n    slug = \"agh\"\n    about = \"A site about cool stuff.\"\n    url = \"https://alokranjan.me\"\n    github = \"ryu-ryuk\"\n    owner = \"ryu\"\n    role = \"Developer\"\n\n    [[members]]\n    name = \"Another Great Guy\"\n    slug = \"another-blog\"\n    about = \"Thoughts on technology and life.\"\n    url = \"https://blogs.alokranjan.me\"\n    github = \"ryu-ryuk\"\n    owner = \"Another Person\"\n    role = \"Writer\"\n    ```\n\n2.  **Customize Templates (Optional):**\n    Modify the HTML templates in the `templates/` directory to match your desired layout and styling.\n\n    * `templates/index.html`\n    * `templates/random.html`\n    * `templates/redirect.html`\n\n3.  **Add Static Assets (Optional):**\n    Place any static files like CSS (`styles.css`) in the `static/` directory.\n\n4.  **Generate Static Files:**\n    Run the generator:\n    ```bash\n    go run main.go\n    ```\n    This will create a `public/` directory containing all the generated HTML files and copied static assets.\n\n## Project Structure\n```\ngo-webring-generator/\n├── main.go # main Go application logic\n├── go.mod # Go module definition\n├── go.sum # Go module checksums\n├── data/\n│   └── members.toml # Webring member data in TOML format\n├── templates/\n│   ├── index.html # Template for the main index page\n│   ├── random.html # Template for the random redirect page\n│   └── redirect.html # Template for the previous/next redirects\n└── static/\n    └── styles.css # Static CSS file \n```\n\n\n## Testing the Generated site\n1. After generating the static files, you can serve them locally to preview your webring: \n```bash\ngo run server.go\n```\n\n2. Then, open your web browser and navigate to [`http:localhost:8080`](http://localhost:8080). \n\n## Automated Workflows \nThis project include Github Action workflows for continuous integration and deployment.\n\n* **TOML Validation (`.github/workflows/validate-toml.yml`)**:\n    Automatically checks the `data/members.toml` file for valid TOML syntax on every push and pull request to ensure data integrity.\n\n* **Deploy to GitHub Pages (`.github/workflows/deploy.yml`)**:\n    Automatically builds the static site and deploys it to GitHub Pages whenever changes are pushed to the `main` branch. This assumes your repository is configured for GitHub Pages (usually from the `/public` folder).\n    To enable this, go to your repository settings on GitHub -\u003e Pages and set the source branch to `gh-pages` or `main` (if you are publishing from `main`'s root, but `peaceiris/actions-gh-pages` typically publishes to `gh-pages` branch, so check your settings).\n\n\n## Contributing\n\nContributions are welcome! Please feel free to open an issue or submit a pull request.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryu-ryuk%2Fgo-webring-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fryu-ryuk%2Fgo-webring-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryu-ryuk%2Fgo-webring-generator/lists"}