https://github.com/ifuture-pro/listify-actions

When you push document . It can generated list of contents to specified file.
https://github.com/ifuture-pro/listify-actions

actions blog directory docs document list-of-contents listify markdown push table-of-contents

Last synced: about 2 months ago
JSON representation

When you push document . It can generated list of contents to specified file.

• Host: GitHub
• URL: https://github.com/ifuture-pro/listify-actions
• Owner: ifuture-pro
• Created: 2019-12-03T13:05:06.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-07T04:45:24.000Z (10 months ago)
• Last Synced: 2024-09-11T19:36:41.530Z (4 months ago)
• Topics: actions, blog, directory, docs, document, list-of-contents, listify, markdown, push, table-of-contents
• Language: Shell
• Homepage:
• Size: 30.3 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Welcome to listify-actions 👋



    

    

  

  

    

  

  

    

  

  

    

  



> When you push document . It will generate list of contents to specified file.  

> Auto generate table of contents  

> Generate and merge all directories to the specified file.

## Usage

### `workflow.yml` Example

Place in a `.yml` file such as this one in your `.github/workflows` folder.   

Refer to the [documentation](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions) on workflow YAML syntax here.

```yaml

name: Auto directories

on: [push]

jobs:

  listify-auto:

    runs-on: ubuntu-latest

    name: listify auto

    steps:

    - name: listify-actions

      uses: ifuture-pro/listify-actions@master

      with:

        listify: ./ --blog

        github_token: ${{ secrets.GH_TOKEN }}

```

### Variables

* `listify`: [Listify options](https://github.com/ifuture-pro/listify#usage) line

* `github_token`: When directory generate completed. Push it to you repository.

## Author

👤 **ifuture**

* Website: https://ifuture.pro

* Github: [@ifuture-pro](https://github.com/ifuture-pro)

## Show your support

Give a ⭐️ if this project helped you!

## 📝 License

Copyright © 2019 [ifuture](https://github.com/ifuture-pro).


This project is [MIT](https://github.com/ifuture-pro/listify/blob/master/LICENSE) licensed.