Markdown-Action-Create-Indexes
The github action that creates index pages for your project, the changes still need to be submitted afterwards.
Its creates a list of each markdown files in the folders and displays it under documents. For each sub folder that has documentation, then that folder is displayed in categories.
Inputs
folder:
The folder path to start at, use ${{github.workspace}}
filename:
The filename of the index file. default to index
Examples
Example usage
# This is a basic workflow to help you get started with Actions
name: Create markdown indexes
# Controls when the action will run.
on:
# Triggers the workflow on push or pull request events but only for the master branch
push:
branches: [ master ]
pull_request:
branches: [ master ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
- uses: actions/checkout@v3
# Runs a single command using the runners shell
- uses: DaanV2/Markdown-Action-Create-Indexes@v1.7.0
with:
folder: ${{github.workspace}}
- name: Commit changes
continue-on-error: true
run: |
cd ${{github.workspace}}
git config --global user.email "Bot@Example.com"
git config --global user.name "DaanV2 Bot"
git add .
git commit -m "auto: Generated markdown indexes"
git push