Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hoijui/mle
Extracts links from markup files. Currently `html` and `markdown` files are supported.
https://github.com/hoijui/mle
cli interfacer-project-eu interfacer-project-eu-wp4-3 library oseg
Last synced: 2 months ago
JSON representation
Extracts links from markup files. Currently `html` and `markdown` files are supported.
- Host: GitHub
- URL: https://github.com/hoijui/mle
- Owner: hoijui
- License: agpl-3.0
- Created: 2022-07-20T11:18:07.000Z (over 2 years ago)
- Default Branch: develop
- Last Pushed: 2024-06-02T15:41:09.000Z (7 months ago)
- Last Synced: 2024-10-13T15:43:46.756Z (3 months ago)
- Topics: cli, interfacer-project-eu, interfacer-project-eu-wp4-3, library, oseg
- Language: Rust
- Homepage:
- Size: 767 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Markup Link Extractor
[](
LICENSE.txt)
[](
https://api.reuse.software/info/github.com/hoijui/mle)
[](
https://github.com/hoijui/mle)
[](
https://crates.io/crates/mle)
[](
https://docs.rs/codify_hoijui)
[](
https://crates.io/crates/mle)
[](
https://deps.rs/repo/github/hoijui/mle)
[](
https://github.com/hoijui/mle/actions)
[](
https://fabcity.hamburg)
[](
https://opensourceecology.de)
Extracts links in markup files.
Currently `html` and `markdown` files are supported.
The main intended purpose of the Markup Link Extractor,
is to extract links fro ma set of files,
and then check them for validity using a separate tool,
e.g. the [Markdown Link *Checker*](https://github.com/becheran/mlc).
Together, two such tools could be integrated in your CI pipeline
to warn about broken links in your markup docs.
## Features
* Find links in `markdown` and `html` files
* Support HTML links and plain URLs in `markdown` files
* User friendly command line interface
* Easy [CI pipeline integration](#ci-pipeline-integration)
* Very fast execution using [async](https://rust-lang.github.io/async-book/)
## Install Locally
There are different ways to install and use *mle*.
### Cargo
Use rust's package manager [cargo](https://doc.rust-lang.org/cargo/)
to install *mle* from [crates.io](https://crates.io/crates/mle):
``` bash
cargo install mle
```
### Download Binaries
To download a compiled binary version of *mle*
go to [github releases](https://github.com/hoijui/mle/releases)
and download the binaries compiled for `x86_64-unknown-linux-gnu`
or `x86_64-apple-darwin`.
## CI Pipeline Integration
### GitHub Actions
Use *mle* in GitHub using the *GitHub-Action*
from the [Marketplace](https://github.com/marketplace/actions/markup-link-checker-mle).
``` yaml
- name: Markup Link Extractor (mle)
uses: hoijui/[email protected]
```
Use *mle* [command line arguments](docs/reference.md) using the `with` argument:
``` yaml
- name: Markup Link Extractor (mle)
uses: hoijui/[email protected]
with:
args: ./README.md
```
### Binary
To integrate *mle* in your CI pipeline running in a *linux x86_64 environment*,
you can add the following commands to download the tool:
``` bash
curl -L https://github.com/hoijui/mle/releases/download/v0.14.3/mle -o mle
chmod +x mle
```
For example take a look at the [ntest repo](https://github.com/becheran/ntest/blob/master/.gitlab-ci.yml)
which uses *mle* in the CI pipeline.
### Docker
Use the *mle* docker image from the [docker hub](https://hub.docker.com/repository/docker/hoijui/mle),
which includes *mle*.
## Usage
Once you have *mle* installed,
it can be called from the command line.
The following call will extract all links in markup files found in the current folder
and all subdirectories:
``` bash
mle
```
Another example is to call *mle* on a certain directory or file:
``` bash
mle ./docs
```
Call *mle* with the `--help` flag to display all available cli arguments:
``` bash
mle -h
```
See the [reference](docs/reference.md) for all available command line arguments.
## Funding
This project was funded by the European Regional Development Fund (ERDF)
in the context of the [INTERFACER Project](https://www.interfacerproject.eu/),
from July 2022 (fork from [`mlc`](https://github.com/becheran/mlc)/project start)
until March 2023.
