From 1d0aceffae1889e8e44e33f187d6428150fc2bf1 Mon Sep 17 00:00:00 2001 From: JA Viljoen Date: Fri, 8 Dec 2023 08:52:43 +0200 Subject: [PATCH] docs: add manual.md pointing to man page This is for those browsing the docs in markdown format on the code forge site. On the HTML site built using the makefile, the link on the installation page points directly to the HTML version of the manpage. --- Makefile | 4 ++-- docs/installation.md | 2 +- docs/manual.md | 7 +++++++ 3 files changed, 10 insertions(+), 3 deletions(-) create mode 100644 docs/manual.md diff --git a/Makefile b/Makefile index 89daa88..25dd590 100644 --- a/Makefile +++ b/Makefile @@ -17,11 +17,11 @@ test: upload-docs: site.tar.gz hut pages publish -d javiljoen.srht.site -s ebookrack/finder/ $< -site.tar.gz: docs/www/ebk-find.1.html +site.tar.gz: docs/www/manual.html python scripts/md2html.py tar caf $@ -C docs/www/ . -docs/www/%.1.html: man/%.1 +docs/www/manual.html: man/ebk-find.1 mandoc -Ios=Linux -Thtml -Ostyle=manpage.css $< > $@ run: diff --git a/docs/installation.md b/docs/installation.md index aaf1508..476ee28 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -15,7 +15,7 @@ $ ebk-find -V ## Manual page -To install the [manual page](ebk-find.1.html), +To install the [manual page](manual.md), place it in a location on your `MANPATH`, e.g.: diff --git a/docs/manual.md b/docs/manual.md new file mode 100644 index 0000000..b13943d --- /dev/null +++ b/docs/manual.md @@ -0,0 +1,7 @@ +# Manual + +To view the manual, +please see the [HTML documentation site][site], +or download `man/ebk-find.1` from the git repo and run `man -l ebk-find.1`. + +[site]: https://javiljoen.srht.site/ebookrack/finder/ -- 2.45.2