Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add auto TOC #49

Merged
merged 3 commits into from
May 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .github/workflows/auto_gen_toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
on:
push:
paths: ['README.md', 'README_CN.md']
pull_request:
paths: ['README.md', 'README_CN.md']

jobs:
build:
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
- uses: actions/checkout@v2
- run: |
curl https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc -o gh-md-toc
chmod a+x gh-md-toc
./gh-md-toc --insert --no-backup README.md
rm -f ./gh-md-toc
- run: |
curl https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc -o gh-md-toc
chmod a+x gh-md-toc
./gh-md-toc --insert --no-backup README_CN.md
rm -f ./gh-md-toc
- uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: Auto update markdown TOC
83 changes: 45 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,44 +26,51 @@ Having been validated through numerous large-scale commercial projects, employin
| [paypal.me/JasonMa0012](paypal.me/JasonMa0012) | ![723ddce6-fb86-48ff-9683-a12cf6cff7a0](./README_CN.assets/723ddce6-fb86-48ff-9683-a12cf6cff7a0.jpg) |


- [Installation](#installation)
- [Usage](#usage)
* [Getting Started](#getting-started)
* [LWGUI Drawers](#lwgui-drawers)
+ [Main & Sub](#main--sub)
+ [SubToggle](#subtoggle)
+ [SubPowerSlider](#subpowerslider)
+ [SubIntRange](#subintrange)
+ [MinMaxSlider](#minmaxslider)
+ [KWEnum](#kwenum)
+ [SubEnum & SubKeywordEnum](#subenum--subkeywordenum)
+ [Tex & Color](#tex--color)
+ [Channel](#channel)
+ [Ramp](#ramp)
+ [Preset](#preset)
- [Create Preset File](#create-preset-file)
- [Edit Preset](#edit-preset)
* [LWGUI Decorator](#lwgui-decorator)
+ [Title & SubTitle](#title--subtitle)
+ [Tooltip & Helpbox](#tooltip--helpbox)
+ [PassSwitch](#passswitch)
+ [Advanced & AdvancedHeaderProperty](#advanced--advancedheaderproperty)
+ [Hidden](#hidden)
+ [ShowIf](#showif)
* [Unity Builtin Drawers](#unity-builtin-drawers)
+ [Space](#space)
+ [Header](#header)
+ [Enum](#enum)
+ [IntRange](#intrange)
+ [KeywordEnum](#keywordenum)
+ [PowerSlider](#powerslider)
+ [Toggle](#toggle)
* [Tips](#tips)
- [Custom Shader GUI](#custom-shader-gui)
* [Custom Header and Footer](#custom-header-and-footer)
* [Custom Drawer](#custom-drawer)
- [TODO](#todo)
- [Contribution](#contribution)
<!--ts-->
* [LWGUI (Light Weight Shader GUI)](#lwgui-light-weight-shader-gui)
* [Installation](#installation)
* [Usage](#usage)
* [Getting Started](#getting-started)
* [LWGUI Drawers](#lwgui-drawers)
* [Main &amp; Sub](#main--sub)
* [SubToggle](#subtoggle)
* [SubPowerSlider](#subpowerslider)
* [SubIntRange](#subintrange)
* [MinMaxSlider](#minmaxslider)
* [KWEnum](#kwenum)
* [SubEnum &amp; SubKeywordEnum](#subenum--subkeywordenum)
* [Tex &amp; Color](#tex--color)
* [Channel](#channel)
* [Ramp](#ramp)
* [Preset](#preset)
* [Create Preset File](#create-preset-file)
* [Edit Preset](#edit-preset)
* [LWGUI Decorator](#lwgui-decorator)
* [Title &amp; SubTitle](#title--subtitle)
* [Tooltip &amp; Helpbox](#tooltip--helpbox)
* [PassSwitch](#passswitch)
* [Advanced &amp; AdvancedHeaderProperty](#advanced--advancedheaderproperty)
* [Hidden](#hidden)
* [ReadOnly](#readonly)
* [ShowIf](#showif)
* [Unity Builtin Drawers](#unity-builtin-drawers)
* [Space](#space)
* [Header](#header)
* [Enum](#enum)
* [IntRange](#intrange)
* [KeywordEnum](#keywordenum)
* [PowerSlider](#powerslider)
* [Toggle](#toggle)
* [Custom Shader GUI](#custom-shader-gui)
* [Custom Header and Footer](#custom-header-and-footer)
* [Custom Drawer](#custom-drawer)
* [TODO](#todo)
* [Contribution](#contribution)

<!-- Created by https://github.com/ekalinin/github-markdown-toc -->
<!-- Added by: runner, at: Wed May 8 08:13:21 UTC 2024 -->

<!--te-->


## Installation
Expand Down
83 changes: 45 additions & 38 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,44 +25,51 @@
| [paypal.me/JasonMa0012](paypal.me/JasonMa0012) | ![723ddce6-fb86-48ff-9683-a12cf6cff7a0](./README_CN.assets/723ddce6-fb86-48ff-9683-a12cf6cff7a0.jpg) |


- [Installation](#installation)
- [Usage](#usage)
* [Getting Started](#getting-started)
* [LWGUI Drawers](#lwgui-drawers)
+ [Main & Sub](#main--sub)
+ [SubToggle](#subtoggle)
+ [SubPowerSlider](#subpowerslider)
+ [SubIntRange](#subintrange)
+ [MinMaxSlider](#minmaxslider)
+ [KWEnum](#kwenum)
+ [SubEnum & SubKeywordEnum](#subenum--subkeywordenum)
+ [Tex & Color](#tex--color)
+ [Channel](#channel)
+ [Ramp](#ramp)
+ [Preset](#preset)
- [Create Preset File](#create-preset-file)
- [Edit Preset](#edit-preset)
* [LWGUI Decorator](#lwgui-decorator)
+ [Title & SubTitle](#title--subtitle)
+ [Tooltip & Helpbox](#tooltip--helpbox)
+ [PassSwitch](#passswitch)
+ [Advanced & AdvancedHeaderProperty](#advanced--advancedheaderproperty)
+ [Hidden](#hidden)
+ [ShowIf](#showif)
* [Unity Builtin Drawers](#unity-builtin-drawers)
+ [Space](#space)
+ [Header](#header)
+ [Enum](#enum)
+ [IntRange](#intrange)
+ [KeywordEnum](#keywordenum)
+ [PowerSlider](#powerslider)
+ [Toggle](#toggle)
* [Tips](#tips)
- [Custom Shader GUI](#custom-shader-gui)
* [Custom Header and Footer](#custom-header-and-footer)
* [Custom Drawer](#custom-drawer)
- [TODO](#todo)
- [Contribution](#contribution)
<!--ts-->
* [LWGUI (Light Weight Shader GUI)](#lwgui-light-weight-shader-gui)
* [Installation](#installation)
* [Usage](#usage)
* [Getting Started](#getting-started)
* [LWGUI Drawers](#lwgui-drawers)
* [Main &amp; Sub](#main--sub)
* [SubToggle](#subtoggle)
* [SubPowerSlider](#subpowerslider)
* [SubIntRange](#subintrange)
* [MinMaxSlider](#minmaxslider)
* [KWEnum](#kwenum)
* [SubEnum &amp; SubKeywordEnum](#subenum--subkeywordenum)
* [Tex &amp; Color](#tex--color)
* [Channel](#channel)
* [Ramp](#ramp)
* [Preset](#preset)
* [Create Preset File](#create-preset-file)
* [Edit Preset](#edit-preset)
* [LWGUI Decorator](#lwgui-decorator)
* [Title &amp; SubTitle](#title--subtitle)
* [Tooltip &amp; Helpbox](#tooltip--helpbox)
* [PassSwitch](#passswitch)
* [Advanced &amp; AdvancedHeaderProperty](#advanced--advancedheaderproperty)
* [Hidden](#hidden)
* [ReadOnly](#readonly)
* [ShowIf](#showif)
* [Unity Builtin Drawers](#unity-builtin-drawers)
* [Space](#space)
* [Header](#header)
* [Enum](#enum)
* [IntRange](#intrange)
* [KeywordEnum](#keywordenum)
* [PowerSlider](#powerslider)
* [Toggle](#toggle)
* [Custom Shader GUI](#custom-shader-gui)
* [Custom Header and Footer](#custom-header-and-footer)
* [Custom Drawer](#custom-drawer)
* [TODO](#todo)
* [Contribution](#contribution)

<!-- Created by https://github.com/ekalinin/github-markdown-toc -->
<!-- Added by: runner, at: Wed May 8 08:13:21 UTC 2024 -->

<!--te-->


## Installation
Expand Down
Loading