From 6dd1eee23896383c3b320cdb52fb996aceda6f65 Mon Sep 17 00:00:00 2001 From: Bastian Venthur Date: Sat, 6 Jul 2024 15:18:45 +0200 Subject: [PATCH] added serve-docs and manpage --- CHANGELOG.md | 3 +++ Makefile | 8 ++++++++ debian/blag.1 | 28 ++++++++++++++++++++++++++++ 3 files changed, 39 insertions(+) create mode 100644 debian/blag.1 diff --git a/CHANGELOG.md b/CHANGELOG.md index 908a0e4..6a42d20 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,9 @@ ## [unreleased] +* added manpage +* added makefile target for generating blog's manpage +* added makefile target for serving blags docs locally * updated dependencies ## [2.3.0] -- 2024-04-24 diff --git a/Makefile b/Makefile index 13e2bfd..5b8208e 100644 --- a/Makefile +++ b/Makefile @@ -57,6 +57,14 @@ update-pygmentize: $(VENV) docs: $(VENV) $(BIN)/mkdocs build +.PHONY: serve-docs +serve-docs: $(VENV) + $(BIN)/mkdocs serve + +.PHONY: manpage +manpage: $(VENV) + help2man $(BIN)/blag --no-info -n "blog-aware, static site generator" -o debian/blag.1 + .PHONY: clean clean: rm -rf build dist *.egg-info diff --git a/debian/blag.1 b/debian/blag.1 new file mode 100644 index 0000000..019f2f9 --- /dev/null +++ b/debian/blag.1 @@ -0,0 +1,28 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. +.TH BLAG "1" "July 2024" "blag 2.3.0" "User Commands" +.SH NAME +blag \- blog-aware, static site generator +.SH DESCRIPTION +usage: blag [\-h] [\-\-version] [\-v] {build,quickstart,serve} ... +.SS "positional arguments:" +.IP +{build,quickstart,serve} +.TP +build +Build website. +.TP +quickstart +Quickstart blag, creating necessary configuration. +.TP +serve +Start development server. +.SS "options:" +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-\-version\fR +show program's version number and exit +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Verbose output.