https://github.com/mipmip/github-action-markdown-link-extract-to-json
Extracts link from a section inside a markdown file and stores them into a json file
https://github.com/mipmip/github-action-markdown-link-extract-to-json
Last synced: 5 months ago
JSON representation
Extracts link from a section inside a markdown file and stores them into a json file
- Host: GitHub
- URL: https://github.com/mipmip/github-action-markdown-link-extract-to-json
- Owner: mipmip
- License: mit
- Created: 2022-06-28T12:23:51.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-06T10:49:09.000Z (over 3 years ago)
- Last Synced: 2025-03-24T09:51:21.398Z (10 months ago)
- Language: JavaScript
- Size: 463 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Github action markdown link extract to json
Extracts link from a section inside a markdown file and stores them into a json file
## Inputs
### `in-file`
**Required** Input filename with markdown.
### `out-file`
**Required** Output filename in which links are store as json.
### `section`
**Optional** Section to parse in stead of whole document.
## Example usage
```
uses: actions/github-action-markdown-link-extract-to-json@v1.1
with:
in-file: README.md
out-file: './links.json'
section: '## Links'
```
## Example Implementation
This is action is developed for Quiqr Community Templates. It helps converting all links to templates from the README into a json-file which is used by the Quiqr Desktop application. [Open the workflow](https://github.com/quiqr/quiqr-community-templates/blob/main/.github/workflows/generate-json.yml) to see how it works.
[Quiqr](https://quiqr.org) - Hugo Websites for everyone
## Contribute
Issues and PR's are welcome. Be polite.