jayanta525/github-pages-directory-listing
1
Fork 0
mirror of https://github.com/jayanta525/github-pages-directory-listing.git synced 2025-06-18 14:15:33 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity
Directory listing for Github Pages
20 Commits 2 Branches 3 Tags 153 KiB
Python 79.9%
HTML 16%
Dockerfile 3.7%
Shell 0.4%
9e5e281423
Go to file
Jayantajit Gogoi 9e5e281423
Update LICENSE
2023-03-19 11:11:22 +05:30
.devcontainer devcontainer: add configuration json 2022-08-05 18:46:16 +00:00
.github actions: update workflow to checkout different branch 2022-08-05 19:19:26 +00:00
docs docs: add documentations 2022-08-05 18:46:16 +00:00
src python: add icon png, fix time format 2022-09-27 10:08:10 +00:00
tests github actions template 2022-08-05 18:46:16 +00:00
action.yml license: add MIT license 2022-08-05 18:46:16 +00:00
Dockerfile github actions template 2022-08-05 18:46:16 +00:00
entrypoint.sh github actions template 2022-08-05 18:46:16 +00:00
LICENSE Update LICENSE 2023-03-19 11:11:22 +05:30
README.md README: update readme to add usage options 2022-08-15 10:28:02 +05:30

README.md

Github Pages Directory Listing

license Paypal Donate

Generate Directory Listings for Github Pages using Github Actions.

Demo

Usage

Getting Started

Add a .github/workflows/workflow.yml to the root of your project where you want directory listings to be enabled.

name: directory-listing
on: [push]

jobs:
  pages-directory-listing-release:
    runs-on: ubuntu-latest
    name: Directory Listings Index
    steps:
      - name: Checkout Repository
        uses: actions/checkout@v3
        with:
          ref: dummy-data    #checkout different branch

      - name: Generate Directory Listings
        uses: jayanta525/github-pages-directory-listing@v2.0.0
        with:
          FOLDER: data    #directory to generate index

      - name: Deploy to Pages
        uses: JamesIves/github-pages-deploy-action@4.1.3
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          BRANCH: gh-pages
          FOLDER: data

Options

Checkout different branch

      - name: Checkout Repository
        uses: actions/checkout@v3
        with:
          ref: dummy-data    #checkout different branch

Choosing a folder to generate indexing

      - name: Generate Directory Listings
        uses: jayanta525/github-pages-directory-listing@v2.0.0
        with:
          FOLDER: data    #directory to generate index

Demo

demo URL: https://jayanta525.github.io/openwrt-r4s-kmods/

image