From e86bdc9707a469f70820bc2c5ec2c88d8b86e878 Mon Sep 17 00:00:00 2001 From: Filip Lajszczak Date: Wed, 15 Nov 2023 19:27:30 +0000 Subject: doc: More explanations on sourcehut publisher. * doc/haunt.texi (Sourcehut): hut cli configuration prequisites. --- doc/haunt.texi | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/haunt.texi b/doc/haunt.texi index 96dc134..5cec034 100644 --- a/doc/haunt.texi +++ b/doc/haunt.texi @@ -1011,9 +1011,15 @@ overrides the set of command line flags used. @deffn {Procedure} sourcehut-publisher [#:name 'production] [#:hut] [#:tar] Return a new publisher named @var{name} that publishes a site to -Sourcehut pages using the site's configured domain. Passing @var{hut} -and/or @var{tar} overrides the default @command{hut} and @command{tar} -executables used. +@url{https://srht.site/, sourcehut pages} using the site's configured +domain. Passing @var{hut} and/or @var{tar} overrides the default +@command{hut} and @command{tar} executables used. + +For the publisher to work, the @command{hut} CLI tool that is used +under the hood has to be configured. One can do so by creating +@file{~/.config/hut/config} manually or by running the @command{hut +init} command. In both cases an OAuth access token needs to be +generated via @url{https://meta.sr.ht/oauth2, sourcehut meta}. @end deffn @node Artifacts -- cgit v1.2.3