{"id":38915780,"url":"https://github.com/raideno/awesome-website","last_synced_at":"2026-01-17T15:26:14.930Z","repository":{"id":306679214,"uuid":"1024472971","full_name":"raideno/awesome-website","owner":"raideno","description":"A tool to generate and deploy a visually appealing, filterable website from a YAML file of curated resources. Ideal for creating and sharing \"awesome lists\".","archived":false,"fork":false,"pushed_at":"2025-10-28T10:00:21.000Z","size":7290,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-28T11:34:16.497Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://raideno.github.io/awesome-website/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/raideno.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-07-22T18:51:02.000Z","updated_at":"2025-10-28T10:00:22.000Z","dependencies_parsed_at":"2025-10-28T11:22:29.279Z","dependency_job_id":"f33aef33-487e-43b4-8b35-b1cc9da83593","html_url":"https://github.com/raideno/awesome-website","commit_stats":null,"previous_names":["raideno/awesome-website"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/raideno/awesome-website","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raideno%2Fawesome-website","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raideno%2Fawesome-website/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raideno%2Fawesome-website/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raideno%2Fawesome-website/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/raideno","download_url":"https://codeload.github.com/raideno/awesome-website/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raideno%2Fawesome-website/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28511443,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T13:38:16.342Z","status":"ssl_error","status_checked_at":"2026-01-17T13:37:44.060Z","response_time":85,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":"2026-01-17T15:26:14.775Z","updated_at":"2026-01-17T15:26:14.898Z","avatar_url":"https://github.com/raideno.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Awesome Website\n\n**NOTE:** To easily deploy an awesome list; Use the [**Template Repository**](https://github.com/raideno/easy-awesome-website).\n\nThis repository contains the source code for \"Awesome Website\", a project that transforms a simple YAML file into a beautiful, interactive, and easily deployable website. It's the perfect solution for creating and maintaining \"awesome lists\" with a polished and professional look.\n\n**Demo:** [https://raideno.github.io/awesome-website](https://raideno.github.io/awesome-website/)\n\n![website-preview](./assets/preview.png)\n\n## Getting Started\n\nTo create your own awesome list website, you'll need to fork this repository and modify the `example.list.yaml` file.\n\n### Usage\n\n```yaml\nname: Deploy Awesome Website to GitHub Pages\n\non:\n  push:\n    branches: [main]\n  workflow_dispatch:\n\njobs:\n  build-and-deploy:\n    runs-on: ubuntu-latest\n    permissions:\n      contents: read\n      pages: write\n      id-token: write\n    steps:\n      - name: checkout repository\n        uses: actions/checkout@v4\n\n      - name: build awesome website\n        uses: raideno/awesome-website@main\n        with:\n          # Formatted according to the structure specified below\n          yaml-path: 'example.list.yaml'\n\n      - name: upload build artifact\n        uses: actions/upload-pages-artifact@v3\n        with:\n          path: awesome-website-src/dist\n          name: github-pages\n\n      - name: deploy to github pages\n        id: deployment\n        uses: actions/deploy-pages@v4\n        with:\n          artifact_name: github-pages\n\n```\n\n1. **Create a GitHub repository.**\n2. **Create List File:** Copy [`example.list.yaml`](./example.list.yaml) into your repository.\n3. **Customize your list:** Edit the `example.list.yaml` file to add your own title, description, and list of resources. See the [YAML File Structure](#yaml-file-structure) section below for a detailed explanation of the available fields.\n4. **Enable GitHub Pages:** In your repository's settings, go to the \"Pages\" section and select \"GitHub Actions\" as the source. This will trigger the deployment workflow.\n5. **Create Workflow file:** Copy [.github/workflows/deploy-awesome-website.yml](./.github/workflows/deploy-awesome-website.yml) into your repository.\n6. **Finally:** Push your changes and wait for the github action to complete in order to see your changes.\n\nYour new awesome list website will be available at `https://\u003cyour-username\u003e.github.io/\u003cyour-repository-name\u003e/`.\n\n## YAML File Structure\n\nThe `example.list.yaml` file has a clear structure that's easy to understand and modify. Below is a breakdown of each section and its purpose.\n\n| Field         | Type                 | Description                                                             |\n| :------------ | :------------------- | :---------------------------------------------------------------------- |\n| `title`       | String               | The main title of your awesome list.                                    |\n| `description` | String               | A short description of your list that will appear in the header.        |\n| `author`      | String               | The name of the primary author of the list.                             |\n| `thumbnail`   | URL                  | An optional URL for a thumbnail image to be displayed in the header.    |\n| `links`       | Array of Url Strings | A list of additional links to be displayed in the header.               |\n| `elements`    | Array of Objects     | The core of your awesome list, where each object represents a resource. |\n\n\n### Element Object Structure\n\n| Field         | Type             | Description                                                             |\n| :------------ | :--------------- | :---------------------------------------------------------------------- |\n| `name`        | String           | The name of the resource.                                               |\n| `description` | String           | A short description of the resource.                                    |\n| `link`        | Url              | A relevant URL for the resource (e.g., website, GitHub, documentation). |\n| `tags`        | Array of Strings | A list of tags specific to this resource for filtering.                 |\n| `notes`       | String           | A long detailed notes that support markdown and latex.                  |\n| `group`       | String           | The group to which belongs this element.                                |\n\n## Deployment\n\nThis project includes a GitHub Actions workflow that automatically builds and deploys your website to GitHub Pages. The workflow is triggered every time you push a change to the `main` branch.\n\nTo enable automated deployments, make sure to configure GitHub Pages to use the \"GitHub Actions\" source in your repository's settings.\n\n## Contribution \u0026 Development\n\nCopy the [`.env.example`](./.env.example) file to `.env` and fill in the required values.\n\n- Development: `npm run dev`\n- Build: `npm run build`\n- Start Build: `npm run start`\n\nDo your changes in a separate branch and create a pull request to merge them into the `main` branch or `develop` branch if you are working on a feature.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraideno%2Fawesome-website","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fraideno%2Fawesome-website","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraideno%2Fawesome-website/lists"}