{"id":16688488,"url":"https://github.com/hoijui/mle","last_synced_at":"2026-01-06T02:05:37.412Z","repository":{"id":50675939,"uuid":"515950834","full_name":"hoijui/mle","owner":"hoijui","description":"Extracts links from markup files. Currently `html` and `markdown` files are supported.","archived":false,"fork":false,"pushed_at":"2024-06-02T15:41:09.000Z","size":785,"stargazers_count":1,"open_issues_count":5,"forks_count":0,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2025-03-11T19:40:32.152Z","etag":null,"topics":["cli","interfacer-project-eu","interfacer-project-eu-wp4-3","library","oseg"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hoijui.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-07-20T11:18:07.000Z","updated_at":"2024-06-02T15:41:12.000Z","dependencies_parsed_at":"2024-10-28T11:29:48.146Z","dependency_job_id":"2ac7191f-7201-4e9e-97bb-d7dbe15390e4","html_url":"https://github.com/hoijui/mle","commit_stats":{"total_commits":576,"total_committers":7,"mean_commits":82.28571428571429,"dds":0.5694444444444444,"last_synced_commit":"b744ad671270808598151771e845ce0f34a660e2"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hoijui%2Fmle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hoijui%2Fmle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hoijui%2Fmle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hoijui%2Fmle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hoijui","download_url":"https://codeload.github.com/hoijui/mle/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245401398,"owners_count":20609167,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","interfacer-project-eu","interfacer-project-eu-wp4-3","library","oseg"],"created_at":"2024-10-12T15:43:55.261Z","updated_at":"2026-01-06T02:05:32.382Z","avatar_url":"https://github.com/hoijui.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--\nSPDX-FileCopyrightText: 2022-2023 Robin Vobruba \u003choijui.quaero@gmail.com\u003e\nSPDX-FileCopyrightText: 2020 Armin Becher \u003cbecherarmin@gmail.com\u003e\n\nSPDX-License-Identifier: CC0-1.0\n--\u003e\n\n# Markup Link Extractor\n\n[![License: AGPL-3.0-or-later](\n    https://img.shields.io/badge/License-AGPL%203.0+-blue.svg)](\n    LICENSE.txt)\n[![REUSE status](\n    https://api.reuse.software/badge/github.com/hoijui/mle)](\n    https://api.reuse.software/info/github.com/hoijui/mle)\n[![Repo](\n    https://img.shields.io/badge/Repo-GitHub-555555\u0026logo=github.svg)](\n    https://github.com/hoijui/mle)\n[![Package Releases](\n    https://img.shields.io/crates/v/mle.svg?color=orange)](\n    https://crates.io/crates/mle)\n[![Documentation Releases](\n    https://img.shields.io/badge/docs.rs-codify_hoijui-66c2a5?labelColor=555555\u0026logo=docs.rs)](\n    https://docs.rs/codify_hoijui)\n[![downloads](\n    https://badgen.net/crates/d/mle?color=blue)](\n    https://crates.io/crates/mle)\n[![Dependency Status](\n    https://deps.rs/repo/github/hoijui/mle/status.svg)](\n    https://deps.rs/repo/github/hoijui/mle)\n[![Build Status](\n    https://github.com/hoijui/mle/workflows/build/badge.svg)](\n    https://github.com/hoijui/mle/actions)\n\n[![In cooperation with FabCity Hamburg](\n    https://raw.githubusercontent.com/osegermany/tiny-files/master/res/media/img/badge-fchh.svg)](\n    https://fabcity.hamburg)\n[![In cooperation with Open Source Ecology Germany](\n    https://raw.githubusercontent.com/osegermany/tiny-files/master/res/media/img/badge-oseg.svg)](\n    https://opensourceecology.de)\n\n\u003c!--\n[![asciicast](\n    https://asciinema.org/a/299100.svg)](\n    https://asciinema.org/a/299100)\n--\u003e\n\nExtracts links in markup files.\nCurrently `html` and `markdown` files are supported.\nThe main intended purpose of the Markup Link Extractor,\nis to extract links fro ma set of files,\nand then check them for validity using a separate tool,\ne.g. the [Markdown Link *Checker*](https://github.com/becheran/mlc).\nTogether, two such tools could be integrated in your CI pipeline\nto warn about broken links in your markup docs.\n\n## Features\n\n* Find links in `markdown` and `html` files\n* Support HTML links and plain URLs in `markdown` files\n* User friendly command line interface\n* Easy [CI pipeline integration](#ci-pipeline-integration)\n* Very fast execution using [async](https://rust-lang.github.io/async-book/)\n\n\u003c!--\n* Throttle option to prevent *429 Too Many Requests* errors\n--\u003e\n\n## Install Locally\n\nThere are different ways to install and use *mle*.\n\n### Cargo\n\nUse rust's package manager [cargo](https://doc.rust-lang.org/cargo/)\nto install *mle* from [crates.io](https://crates.io/crates/mle):\n\n``` bash\ncargo install mle\n```\n\n### Download Binaries\n\nTo download a compiled binary version of *mle*\ngo to [github releases](https://github.com/hoijui/mle/releases)\nand download the binaries compiled for `x86_64-unknown-linux-gnu`\nor `x86_64-apple-darwin`.\n\n## CI Pipeline Integration\n\n### GitHub Actions\n\nUse *mle* in GitHub using the *GitHub-Action*\nfrom the [Marketplace](https://github.com/marketplace/actions/markup-link-checker-mle).\n\n``` yaml\n- name: Markup Link Extractor (mle)\n  uses: hoijui/mle@v0.14.3\n```\n\nUse *mle* [command line arguments](docs/reference.md) using the `with` argument:\n\n``` yaml\n- name: Markup Link Extractor (mle)\n  uses: hoijui/mle@v0.14.3\n  with:\n    args: ./README.md\n```\n\n### Binary\n\nTo integrate *mle* in your CI pipeline running in a *linux x86_64 environment*,\nyou can add the following commands to download the tool:\n\n``` bash\ncurl -L https://github.com/hoijui/mle/releases/download/v0.14.3/mle -o mle\nchmod +x mle\n```\n\nFor example take a look at the [ntest repo](https://github.com/becheran/ntest/blob/master/.gitlab-ci.yml)\nwhich uses *mle* in the CI pipeline.\n\n### Docker\n\nUse the *mle* docker image from the [docker hub](https://hub.docker.com/repository/docker/hoijui/mle),\nwhich includes *mle*.\n\n## Usage\n\nOnce you have *mle* installed,\nit can be called from the command line.\nThe following call will extract all links in markup files found in the current folder\nand all subdirectories:\n\n``` bash\nmle\n```\n\nAnother example is to call *mle* on a certain directory or file:\n\n``` bash\nmle ./docs\n```\n\nCall *mle* with the `--help` flag to display all available cli arguments:\n\n``` bash\nmle -h\n```\n\nSee the [reference](docs/reference.md) for all available command line arguments.\n\n## Funding\n\nThis project was funded by the European Regional Development Fund (ERDF)\nin the context of the [INTERFACER Project](https://www.interfacerproject.eu/),\nfrom July 2022 (fork from [`mlc`](https://github.com/becheran/mlc)/project start)\nuntil March 2023.\n\n![Logo of the EU ERDF program](\n    https://cloud.fabcity.hamburg/s/TopenKEHkWJ8j5P/download/logo-eu-erdf.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhoijui%2Fmle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhoijui%2Fmle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhoijui%2Fmle/lists"}