mdcat 2.7.1

cat for markdown: Show markdown documents in terminals
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

name: "Test & Lint"

on:
  push:
    # Don't run CI for tags; there's always a branch for the tag as well so
    # there's no point in testing it separately
    tags-ignore: "*"
    # Only test direct pushes to main; for other branches we can always create a
    # (draft) PR if we need CI. See https://github.com/orgs/community/discussions/26276#discussioncomment-3251154
    # for the general idea.
    branches: main
    paths-ignore:
      - screenshots/**
      - README.md
      - CHANGELOG.md
      - LICENSE
  pull_request:

jobs:
  # See https://mozilla.github.io/cargo-vet/configuring-ci.html
  cargo-vet:
    runs-on: ubuntu-latest
    env:
      CARGO_VET_VERSION: 0.10.0
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
      - uses: actions/cache@v4
        with:
          path: ${{ runner.tool_cache }}/cargo-vet
          key: cargo-vet-bin-${{ env.CARGO_VET_VERSION }}
      - run: echo "${{ runner.tool_cache }}/cargo-vet/bin" >> $GITHUB_PATH
      - run: cargo install --root ${{ runner.tool_cache }}/cargo-vet --version ${{ env.CARGO_VET_VERSION }} cargo-vet
      - run: cargo vet --locked

  # Lint things which are independent from the build target
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      # Scripts
      - uses: docker://mvdan/shfmt
        with:
          args: -i 4 -l -d scripts/combine-screenshots scripts/package scripts/screenshot-windows
      - uses: docker://koalaman/shellcheck:stable
        with:
          args: -S style -o all scripts/combine-screenshots scripts/package scripts/screenshot-windows

      - uses: dtolnay/rust-toolchain@stable
        with:
          components: rustfmt

      # Test formatting
      - run: cargo fmt --all -- --check

      # Dependency policies
      - uses: EmbarkStudios/cargo-deny-action@v2
      - uses: EmbarkStudios/cargo-deny-action@v2
        with:
          arguments: "--no-default-features"
          manifest-path: "./pulldown-cmark-mdcat/Cargo.toml"

      # Manpage
      - uses: docker://asciidoctor/docker-asciidoctor
        with:
          args: asciidoctor -b manpage -a reproducible --warnings mdcat.1.adoc
      - run: man -l --warnings=w --pager=cat mdcat.1
        env:
          MANWIDTH: 80

  # Test mdcat itself
  test:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest]
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
        with:
          components: clippy

      # Since Windows builds are comparatively slow, we skip quite a few builds on Windows to speed up pipelines

      # Test library with no features
      - run: cargo build -p pulldown-cmark-mdcat --all-targets --locked --no-default-features
        if: ${{ !contains(matrix.os, 'windows') }}
      - run: cargo clippy -p pulldown-cmark-mdcat --all-targets --locked --no-default-features
        if: ${{ !contains(matrix.os, 'windows') }}
      - run: cargo test -p pulldown-cmark-mdcat --locked --no-default-features
        if: ${{ !contains(matrix.os, 'windows') }}
      - run: cargo doc -p pulldown-cmark-mdcat --locked --no-default-features
        if: ${{ !contains(matrix.os, 'windows') }}

      # Build and test entire workspace in default configuration
      - run: cargo build --workspace --all-targets --locked
      - run: cargo clippy --workspace --all-targets --locked
      - run: cargo test --workspace --locked
      - run: cargo doc --workspace --locked
        if: ${{ !contains(matrix.os, 'windows') }}

      # Run on our complete example, just to assert that the CLI doesn't crash
      - run: cargo run -- sample/common-mark.md