diff --git a/Makefile b/Makefile index 432d3bc..30de19e 100644 --- a/Makefile +++ b/Makefile @@ -33,3 +33,7 @@ run: ## Run project locally .PHONY: docs docs: ## Generate and show documentation cargo doc --open + +.PHONY: screencast +screencast: ## Create a screencast for the docs + svg-term --command 'assets/screencast.sh' --out 'assets/screencast.svg' --width 100 --padding 10 --window \ No newline at end of file diff --git a/README.md b/README.md index c3ae8fe..11b1e0b 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ reStructuredText, or any other text file or website! Available as a command-line utility, a library and a [GitHub Action](https://github.com/lycheeverse/lychee-action). -![Lychee demo](./assets/lychee.gif) +![Lychee demo](./assets/screencast.svg) ## Installation diff --git a/assets/screencast.sh b/assets/screencast.sh new file mode 100644 index 0000000..dafd91e --- /dev/null +++ b/assets/screencast.sh @@ -0,0 +1,60 @@ +#!/usr/bin/env bash +# +# Adapted from +# https://github.com/marionebl/svg-term-cli +# https://github.com/sharkdp/fd/blob/master/doc/screencast.sh +# +# Designed to be executed via svg-term from the lychee root directory: +# svg-term --command="bash assets/screencast.sh" --out assets/screencast.svg --padding=10 +# Then run this (workaround for https://github.com/sharkdp/fd/issues/1003): +# sed -i '' 's/❯❯l❯ly❯lyc❯lych❯lyche❯lychee❯lycheeREADME.md⠁0/0[00:00:00]█████████████████████████🔍52Total✅52OK🚫0Errors❯lychee-❯lychee--❯lychee--verbose❯lychee--verbose--format=json❯lychee--verbose--format=jsonfixtures/test.html✔[200]https://hello-rust.show/10/✔[200]https://endler.dev/2020/rust-compile-times/{"total":2,"successful":2,"failures":0,"unknown":0,"timeouts":0,"redirects":0,"excludes":0,"errors":0,"cached":0,"fail_map":{}}❯lychee--no-progress❯lychee--no-progress--formatdetailed❯lychee--no-progress--formatdetailedhttps://example.com📝Summary---------------------🔍Total............1✅Successful.......1⏳Timeouts.........0🔀Redirected.......0👻Excluded.........0❓Unknown..........0🚫Errors...........0❯lychee--dump❯lychee--dump--include❯lychee--dump--includegithub❯lychee--dump--includegithub--❯lychee--dump--includegithub--'./**/*.md'https://github.com/lycheeverse/lychee#github-tokenhttps://github.com/rust-lang/crates.io/issues/788https://wilsonmar.github.io/maximum-limits/https://github.com/analysis-tools-dev/static-analysis/issues/350octocat+github@github.comhttps://github.com/rust-lang/rusthttps://github.com/lycheeverse/lycheehttps://github.com/raviqqe/muffethttps://github.com/analysis-tools-dev/dynamic-analysishttps://github.com/papers-we-love/papers-we-lovehttps://github.com/lycheeverse/lychee/blob/master/lychee.example.tomlhttps://github.com/ramitsurana/awesome-kuberneteshttps://github.com/dkhamsing/awesome_bothttps://github.com/hello-rust/lychee/workflows/Rust/badge.svghttps://github.com/lycheeverse/lychee/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22https://github.com/Azure/ResourceModuleshttps://github.com/launchdarkly/LaunchDarkly-Docshttps://github.com/tcort/markdown-link-check/issues/94https://github.com/JustinBeckwith/linkinatorhttps://github.com/opensearch-project/OpenSearchhttps://github.com/pawroman/linkshttps://github.com/mre/idiomatic-rust-doesnt-exist-man❯lycheeR❯lycheeRE❯lycheeREA❯lycheeREAD❯lycheeREADME❯lycheeREADME.❯lycheeREADME.m⠉15/52[00:00:00]███████░░░░░░░░░░░░░░░░░░✔[200]https://github.com/settings/tokens⠙48/52[00:00:01]███████████████████████░░✔[200]https://github.com/lycheeverse/lychee/releases⠚50/52[00:00:01]████████████████████████░✔[200]https://github.com/Azure/ResourceModules❯lychee--v❯lychee--ve❯lychee--ver❯lychee--verb❯lychee--verbo❯lychee--verbos❯lychee--verbose-❯lychee--verbose--❯lychee--verbose--f❯lychee--verbose--fo❯lychee--verbose--for❯lychee--verbose--form❯lychee--verbose--forma❯lychee--verbose--format❯lychee--verbose--format=❯lychee--verbose--format=j❯lychee--verbose--format=js❯lychee--verbose--format=jso❯lychee--verbose--format=jsonf❯lychee--verbose--format=jsonfi❯lychee--verbose--format=jsonfix❯lychee--verbose--format=jsonfixt❯lychee--verbose--format=jsonfixtu❯lychee--verbose--format=jsonfixtur❯lychee--verbose--format=jsonfixture❯lychee--verbose--format=jsonfixtures❯lychee--verbose--format=jsonfixtures/❯lychee--verbose--format=jsonfixtures/t❯lychee--verbose--format=jsonfixtures/te❯lychee--verbose--format=jsonfixtures/tes❯lychee--verbose--format=jsonfixtures/test❯lychee--verbose--format=jsonfixtures/test.❯lychee--verbose--format=jsonfixtures/test.h❯lychee--verbose--format=jsonfixtures/test.ht❯lychee--verbose--format=jsonfixtures/test.htm⠁1/2[00:00:00]████████████░░░░░░░░░░░░░✔[200]https://hello-rust.show/10/⠁2/2[00:00:00]█████████████████████████✔[200]https://endler.dev/2020/rust-compile-times/❯lychee--n❯lychee--no❯lychee--no-p❯lychee--no-pr❯lychee--no-pro❯lychee--no-prog❯lychee--no-progr❯lychee--no-progres❯lychee--no-progress-❯lychee--no-progress--❯lychee--no-progress--fo❯lychee--no-progress--for❯lychee--no-progress--form❯lychee--no-progress--forma❯lychee--no-progress--format❯lychee--no-progress--formatd❯lychee--no-progress--formatde❯lychee--no-progress--formatdet❯lychee--no-progress--formatdeta❯lychee--no-progress--formatdetai❯lychee--no-progress--formatdetaile❯lychee--no-progress--formatdetailedh❯lychee--no-progress--formatdetailedht❯lychee--no-progress--formatdetailedhttp❯lychee--no-progress--formatdetailedhttps❯lychee--no-progress--formatdetailedhttps:❯lychee--no-progress--formatdetailedhttps:/❯lychee--no-progress--formatdetailedhttps://❯lychee--no-progress--formatdetailedhttps://ex❯lychee--no-progress--formatdetailedhttps://exa❯lychee--no-progress--formatdetailedhttps://exam❯lychee--no-progress--formatdetailedhttps://examp❯lychee--no-progress--formatdetailedhttps://exampl❯lychee--no-progress--formatdetailedhttps://example.❯lychee--no-progress--formatdetailedhttps://example.c❯lychee--no-progress--formatdetailedhttps://example.co❯lychee--d❯lychee--du❯lychee--dum❯lychee--dump-❯lychee--dump--❯lychee--dump--i❯lychee--dump--in❯lychee--dump--inc❯lychee--dump--incl❯lychee--dump--inclu❯lychee--dump--includ❯lychee--dump--includeg❯lychee--dump--includegi❯lychee--dump--includegit❯lychee--dump--includegith❯lychee--dump--includegithu❯lychee--dump--includegithub-❯lychee--dump--includegithub--'❯lychee--dump--includegithub--'.❯lychee--dump--includegithub--'./❯lychee--dump--includegithub--'./*❯lychee--dump--includegithub--'./**❯lychee--dump--includegithub--'./**/❯lychee--dump--includegithub--'./**/*❯lychee--dump--includegithub--'./**/*.❯lychee--dump--includegithub--'./**/*.m❯lychee--dump--includegithub--'./**/*.mdhttps://github.com/hello-rust/lycheehttps://github.com/lycheeverse/lychee/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22https://github.com/lycheeverse/lychee/actions/workflows/links.yml/badge.svghttps://github.com/analysis-tools-dev/static-analysishttps://github.com/microsoft/WhatTheHackhttps://github.com/pingcap/docshttps://github.com/tcort/markdown-link-checkhttps://github.com/lycheeverse/lychee/releaseshttps://github.com/lycheeverse/lychee/actions/workflows/links.ymlhttps://github.com/marketplace/actions/lychee-broken-link-checkerhttps://github.com/raviqqe/liche/issues/13https://github.com/settings/tokenshttps://github.com/linkchecker/linkcheckerhttps://github.com/lycheeverse/lychee-actionhttps://github.com/stevenvachon/broken-link-checkerhttps://github.com/nix-community/awhttps://github.com/nix-community/awesome-nix \ No newline at end of file diff --git a/fixtures/TEST.html b/fixtures/TEST.html index fba01a4..4415bbc 100644 --- a/fixtures/TEST.html +++ b/fixtures/TEST.html @@ -10,7 +10,6 @@ >
  • Hello Rust
    • -
  • Hello Rust