markdown-tui-explorer 1.20.5

A terminal-based markdown file browser and viewer with search, syntax highlighting, and live reload
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

{
  description = "markdown-reader — TUI markdown viewer with mermaid rendering, tabs, vim-mode editor, and live reload";

  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
    flake-utils.url = "github:numtide/flake-utils";
  };

  outputs = { self, nixpkgs, flake-utils, ... }:
    flake-utils.lib.eachDefaultSystem (system:
      let
        pkgs = import nixpkgs { inherit system; };

        cargoToml = builtins.fromTOML (builtins.readFile ./Cargo.toml);

        markdown-reader = pkgs.rustPlatform.buildRustPackage {
          pname = "markdown-reader";
          # Bin name; the workspace package is `markdown-tui-explorer`.
          version = cargoToml.package.version;

          src = pkgs.lib.cleanSource ./.;

          cargoLock = {
            lockFile = ./Cargo.lock;
          };

          # Build only the parent crate; the workspace also contains
          # `mermaid-text` which would otherwise build its own bin.
          cargoBuildFlags = [ "--package" "markdown-tui-explorer" ];

          # Tests run in the Nix sandbox. The `open_link_picker_real_doc_repro`
          # test reads an absolute path on the maintainer's machine and is
          # `#[ignore]` by default, so it's already skipped. Everything else
          # is pure data + tempfiles and works in the sandbox.
          doCheck = true;
          cargoTestFlags = [ "--workspace" ];

          meta = with pkgs.lib; {
            description = cargoToml.package.description;
            homepage = "https://github.com/leboiko/markdown-reader";
            license = licenses.mit;
            maintainers = [ ];
            mainProgram = "markdown-reader";
            platforms = platforms.unix;
          };
        };
      in {
        packages.default = markdown-reader;
        packages.markdown-reader = markdown-reader;

        apps.default = {
          type = "app";
          program = "${markdown-reader}/bin/markdown-reader";
        };

        # `nix develop` opens a shell with everything needed for
        # contributing: rustc/cargo + the side tools our CI runs.
        devShells.default = pkgs.mkShell {
          buildInputs = [
            pkgs.rustc
            pkgs.cargo
            pkgs.rustfmt
            pkgs.clippy
            pkgs.cargo-deny
            pkgs.cargo-audit
          ];
        };
      });
}