Skip to content

Commit d4a3fed

Browse files
committed
docs(README): Write the Introduction section
Signed-off-by: 林博仁(Buo-ren Lin) <buo.ren.lin@gmail.com>
1 parent 1919fed commit d4a3fed

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,17 @@ A utility to convert the navigation sidebar of GitHub documentation pages from H
77

88
\#utility \#github-docs \#markdown
99

10+
## Introduction
11+
12+
This script converts the GitHub Actions documentation sidebar HTML structure
13+
to a GitHub Flavored Markdown (GFM) unordered list format.
14+
15+
The script extracts:
16+
17+
* Text content from span elements with class "prc-ActionList-ItemLabel-TmBhn"
18+
* URL links from href attributes of anchor elements
19+
* Hierarchical structure based on CSS depth indicators (--subitem-depth)
20+
1021
## Licensing
1122

1223
Unless otherwise noted([comment headers](https://reuse.software/spec-3.3/#comment-headers)/[REUSE.toml](https://reuse.software/spec-3.3/#reusetoml)), this product is licensed under [the 3.0 version of the Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.html), or any of its more recent versions of your preference.

0 commit comments

Comments
 (0)