muffy-document 0.4.2

Document types
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

# Muffy

[![GitHub Action](https://img.shields.io/github/actions/workflow/status/raviqqe/muffy/test.yaml?branch=main&style=flat-square)](https://github.com/raviqqe/muffy/actions)
[![Codecov](https://img.shields.io/codecov/c/github/raviqqe/muffy.svg?style=flat-square)](https://codecov.io/gh/raviqqe/muffy)
[![Crate](https://img.shields.io/crates/v/muffy.svg?style=flat-square)](https://crates.io/crates/muffy)
[![Docker Pulls](https://img.shields.io/docker/pulls/raviqqe/muffy?style=flat-square)](https://hub.docker.com/r/raviqqe/muffy)
[![License](https://img.shields.io/github/license/raviqqe/muffy.svg?style=flat-square)](https://github.com/raviqqe/muffy/blob/main/LICENSE)

The static website validator.

## Install

```sh
cargo install muffy
```

## Usage

For the full usage, see `muffy --help`.

### Check a set of websites

```sh
muffy
```

### Check a website

```sh
muffy check-site https://example.com
```

### GitHub Action

```yaml
job:
  steps:
    # After building and/or deploying your website.
    - uses: raviqqe/muffy@v0.4.1
```

See [`action.yaml`](https://github.com/raviqqe/muffy/blob/main/action.yaml) for more details.

## References

- [The Nu HTML validator](https://github.com/validator/validator)
- [Muffet](https://github.com/raviqqe/muffet)

## License

[MIT](https://github.com/raviqqe/muffy/blob/main/LICENSE)