{"id":23654134,"url":"https://github.com/ykicchan/generate-directory-listing-action","last_synced_at":"2025-04-10T12:43:02.822Z","repository":{"id":269816498,"uuid":"908535860","full_name":"yKicchan/generate-directory-listing-action","owner":"yKicchan","description":"GitHub Actions to generate directory listing","archived":false,"fork":false,"pushed_at":"2025-02-03T00:00:40.000Z","size":5079,"stargazers_count":5,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-24T11:38:06.231Z","etag":null,"topics":["action","directory-listing","github-actions","github-pages","indexing","listing","serving-directory"],"latest_commit_sha":null,"homepage":"https://ykicchan.github.io/generate-directory-listing-action/","language":"TypeScript","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/yKicchan.png","metadata":{"files":{"readme":"README.ja.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-26T10:05:12.000Z","updated_at":"2025-03-14T09:50:07.000Z","dependencies_parsed_at":"2024-12-26T11:29:48.877Z","dependency_job_id":"9a9f00e5-f7dc-4734-8cff-5965fa2928ab","html_url":"https://github.com/yKicchan/generate-directory-listing-action","commit_stats":null,"previous_names":["ykicchan/generate-directory-indexing-action"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yKicchan%2Fgenerate-directory-listing-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yKicchan%2Fgenerate-directory-listing-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yKicchan%2Fgenerate-directory-listing-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yKicchan%2Fgenerate-directory-listing-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yKicchan","download_url":"https://codeload.github.com/yKicchan/generate-directory-listing-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248217160,"owners_count":21066634,"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":["action","directory-listing","github-actions","github-pages","indexing","listing","serving-directory"],"created_at":"2024-12-28T18:43:23.154Z","updated_at":"2025-04-10T12:43:02.793Z","avatar_url":"https://github.com/yKicchan.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Language: [🇺🇸](./README.md) [🇯🇵](./README.ja.md)\n\n[![GitHub Release](https://img.shields.io/github/v/release/yKicchan/generate-directory-listing-action)](https://github.com/yKicchan/generate-directory-listing-action/releases)\n[![license](https://img.shields.io/github/license/yKicchan/generate-directory-listing-action)](https://github.com/yKicchan/generate-directory-listing-action/blob/main/LICENSE)\n[![CI](https://github.com/yKicchan/generate-directory-listing-action/actions/workflows/ci.yml/badge.svg)](https://github.com/yKicchan/generate-directory-listing-action/actions/workflows/ci.yml)\n[![Deploy](https://github.com/yKicchan/generate-directory-listing-action/actions/workflows/deploy.yml/badge.svg)](https://github.com/yKicchan/generate-directory-listing-action/actions/workflows/deploy.yml)\n[![Coverage](https://ykicchan.github.io/generate-directory-listing-action/coverage/badge.svg)](https://ykicchan.github.io/generate-directory-listing-action/coverage)\n\n# Generate Directory Listing Action\n\nこの Action は指定のディレクトリ下を探索できる `index.html` を生成します。  \nGitHub Pages などで公開する静的なページの閲覧に便利です。\n\n## デモ\n\n以下はこの Action を使って生成した `index.html` の表示イメージです。  \n宗教上の理由で Dark mode にも対応しています。\n\n| Light Theme | Dark Theme |\n| --- | --- |\n| ![Light Theme Demo](https://github.com/user-attachments/assets/12db5a6a-4b25-45dd-aab6-eac3163e4d10) | ![Dark Theme Demo](https://github.com/user-attachments/assets/db7691a9-8e37-47ac-920f-aa0b4e634b99) |\n\nこの Action を使って生成した実際のデモページは GitHub Pages で公開しています。  \nhttps://ykicchan.github.io/generate-directory-listing-action/\n\n## 使い方\n\n最も簡単な使い方はこの Action を呼び出し、ディレクトリを指定することです。\n\n```yml\n- name: Generate Directory listing\n  uses: yKicchan/generate-directory-listing-action@v1\n  with:\n    target: dist\n```\n\n### バージョンの指定について\n\nこの Action は、セマンティックバージョニングを採用しています。  \n[セキュリティ上の観点](https://docs.github.com/ja/actions/security-for-github-actions/security-guides/security-hardening-for-github-actions)から、コミットハッシュによる固定が最も推奨されます。  \nもしアップデートを受け取りたい場合は、メジャーバージョンまたはマイナーバージョンの指定も可能です。\n\n```yml\n# バージョンは完全に固定し、アップデートを受け取らない\nuses: yKicchan/generate-directory-listing-action@COMMIT_SHA\nuses: yKicchan/generate-directory-listing-action@v1.0.0\n\n# マイナーバージョンで固定し、パッチバージョンのアップデートのみを受け取る\nuses: yKicchan/generate-directory-listing-action@v1.0\n\n# メジャーバージョンで固定し、互換性のあるアップデートを受け取る\nuses: yKicchan/generate-directory-listing-action@v1\n```\n\n### 特定のファイルを除外する\n\n`ignore` オプションを利用することで、特定のパターンにマッチするファイルを除外することができます。\n\n\u003e [!tip]\n\u003e 複数のパターンを指定したい場合は、カンマ区切りで指定します。\n\n```yml\n- name: Generate Directory listing\n  uses: yKicchan/generate-directory-listing-action@v1\n  with:\n    target: dist\n    ignore: \"**/*.map\"\n```\n\n### 表示形式を変更する\n\n`viewType` オプションを利用することで、表示形式を変更することができます。  \n現在は `table` と `list` が利用可能で、デフォルトは `table` です。  \n下記は `list` での表示例です。\n\n```yml\n- name: Generate Directory listing\n  uses: yKicchan/generate-directory-listing-action@v1\n  with:\n    target: dist\n    viewType: \"list\"\n```\n\n| Light Theme | Dark Theme |\n| --- | --- |\n| ![light](https://github.com/user-attachments/assets/7046a514-17d9-49e0-b090-8fa462256088) | ![dark](https://github.com/user-attachments/assets/6b952edd-8d82-4dee-a290-19da264580eb) |\n\n### 見た目をカスタマイズする\n\n追加の CSS を読み込ませて、出力する `index.html` の見た目をカスタマイズすることができます。\n\n\u003e [!warning]\n\u003e カスタマイズした見た目を確実に反映するには、利用バージョンを完全に固定してください。  \n\u003e 例: `uses: yKicchan/generate-directory-listing-action@v1.0.0`  \n\u003e バージョンアップにより HTML 構造が変わる可能性があります。\n\n```yml\n- name: Generate Directory listing\n  uses: yKicchan/generate-directory-listing-action@v1.0\n  with:\n    target: dist\n    # target ディレクトリからの相対パスを指定します\n    theme: \"./custom.css\"\n```\n\n## オプション\n\nカスタマイズが可能なオプションを用意しています。  \n詳細な仕様は [action.yml](./action.yml) を確認してください。\n\n| キーワード | 型 | 必須 | デフォルト値 | 説明 |\n| --- | --- | --- | --- | --- |\n| `target` | string | yes | - | 探索可能にしたいターゲットディレクトリ |\n| `viewType` | string | no | `table` | 表示形式を指定する\u003cbr\u003e現在は `table` と `list` が利用可能 |\n| `ignore` | string | no | - | 探索から排除したい glob パターン、カンマ区切りで複数指定が可能 |\n| `showHiddenFiles` | boolean | no | `false` | 隠しファイルを表示するかどうか |\n| `theme` | string | no | - | 生成される `index.html` を 拡張する CSS スタイル\u003cbr\u003e`target` ディレクトリからの相対パスで指定する |\n| `override` | boolean | no | `false` | すでに `index.html` が存在する時に上書きするかどうか |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fykicchan%2Fgenerate-directory-listing-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fykicchan%2Fgenerate-directory-listing-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fykicchan%2Fgenerate-directory-listing-action/lists"}