https://github.com/ykicchan/generate-directory-listing-action

GitHub Actions to generate directory listing
https://github.com/ykicchan/generate-directory-listing-action

action directory-listing github-actions github-pages indexing listing serving-directory

Last synced: 6 months ago
JSON representation

GitHub Actions to generate directory listing

• Host: GitHub
• URL: https://github.com/ykicchan/generate-directory-listing-action
• Owner: yKicchan
• License: mit
• Created: 2024-12-26T10:05:12.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2025-02-03T00:00:40.000Z (8 months ago)
• Last Synced: 2025-03-24T11:38:06.231Z (7 months ago)
• Topics: action, directory-listing, github-actions, github-pages, indexing, listing, serving-directory
• Language: TypeScript
• Homepage: https://ykicchan.github.io/generate-directory-listing-action/
• Size: 4.84 MB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.ja.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
Language: [🇺🇸](./README.md) [🇯🇵](./README.ja.md)

[![GitHub Release](https://img.shields.io/github/v/release/yKicchan/generate-directory-listing-action)](https://github.com/yKicchan/generate-directory-listing-action/releases)

[![license](https://img.shields.io/github/license/yKicchan/generate-directory-listing-action)](https://github.com/yKicchan/generate-directory-listing-action/blob/main/LICENSE)

[![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)

[![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)

[![Coverage](https://ykicchan.github.io/generate-directory-listing-action/coverage/badge.svg)](https://ykicchan.github.io/generate-directory-listing-action/coverage)

# Generate Directory Listing Action

この Action は指定のディレクトリ下を探索できる `index.html` を生成します。  

GitHub Pages などで公開する静的なページの閲覧に便利です。

## デモ

以下はこの Action を使って生成した `index.html` の表示イメージです。  

宗教上の理由で Dark mode にも対応しています。

| Light Theme | Dark Theme |

| --- | --- |

| ![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) |

この Action を使って生成した実際のデモページは GitHub Pages で公開しています。  

https://ykicchan.github.io/generate-directory-listing-action/

## 使い方

最も簡単な使い方はこの Action を呼び出し、ディレクトリを指定することです。

```yml

- name: Generate Directory listing

  uses: yKicchan/generate-directory-listing-action@v1

  with:

    target: dist

```

### バージョンの指定について

この Action は、セマンティックバージョニングを採用しています。  

[セキュリティ上の観点](https://docs.github.com/ja/actions/security-for-github-actions/security-guides/security-hardening-for-github-actions)から、コミットハッシュによる固定が最も推奨されます。  

もしアップデートを受け取りたい場合は、メジャーバージョンまたはマイナーバージョンの指定も可能です。

```yml

# バージョンは完全に固定し、アップデートを受け取らない

uses: yKicchan/generate-directory-listing-action@COMMIT_SHA

uses: yKicchan/generate-directory-listing-action@v1.0.0

# マイナーバージョンで固定し、パッチバージョンのアップデートのみを受け取る

uses: yKicchan/generate-directory-listing-action@v1.0

# メジャーバージョンで固定し、互換性のあるアップデートを受け取る

uses: yKicchan/generate-directory-listing-action@v1

```

### 特定のファイルを除外する

`ignore` オプションを利用することで、特定のパターンにマッチするファイルを除外することができます。

> [!tip]

> 複数のパターンを指定したい場合は、カンマ区切りで指定します。

```yml

- name: Generate Directory listing

  uses: yKicchan/generate-directory-listing-action@v1

  with:

    target: dist

    ignore: "**/*.map"

```

### 表示形式を変更する

`viewType` オプションを利用することで、表示形式を変更することができます。  

現在は `table` と `list` が利用可能で、デフォルトは `table` です。  

下記は `list` での表示例です。

```yml

- name: Generate Directory listing

  uses: yKicchan/generate-directory-listing-action@v1

  with:

    target: dist

    viewType: "list"

```

| Light Theme | Dark Theme |

| --- | --- |

| ![light](https://github.com/user-attachments/assets/7046a514-17d9-49e0-b090-8fa462256088) | ![dark](https://github.com/user-attachments/assets/6b952edd-8d82-4dee-a290-19da264580eb) |

### 見た目をカスタマイズする

追加の CSS を読み込ませて、出力する `index.html` の見た目をカスタマイズすることができます。

> [!warning]

> カスタマイズした見た目を確実に反映するには、利用バージョンを完全に固定してください。  

> 例: `uses: yKicchan/generate-directory-listing-action@v1.0.0`  

> バージョンアップにより HTML 構造が変わる可能性があります。

```yml

- name: Generate Directory listing

  uses: yKicchan/generate-directory-listing-action@v1.0

  with:

    target: dist

    # target ディレクトリからの相対パスを指定します

    theme: "./custom.css"

```

## オプション

カスタマイズが可能なオプションを用意しています。  

詳細な仕様は [action.yml](./action.yml) を確認してください。

| キーワード | 型 | 必須 | デフォルト値 | 説明 |

| --- | --- | --- | --- | --- |

| `target` | string | yes | - | 探索可能にしたいターゲットディレクトリ |

| `viewType` | string | no | `table` | 表示形式を指定する
現在は `table` と `list` が利用可能 |

| `ignore` | string | no | - | 探索から排除したい glob パターン、カンマ区切りで複数指定が可能 |

| `showHiddenFiles` | boolean | no | `false` | 隠しファイルを表示するかどうか |

| `theme` | string | no | - | 生成される `index.html` を 拡張する CSS スタイル
`target` ディレクトリからの相対パスで指定する |

| `override` | boolean | no | `false` | すでに `index.html` が存在する時に上書きするかどうか |