summaryrefslogtreecommitdiff
path: root/doc/haunt.texi
diff options
context:
space:
mode:
authorFilip Lajszczak <filip@lajszczak.dev>2023-11-15 19:27:30 +0000
committerDavid Thompson <dthompson2@worcester.edu>2023-11-16 07:31:33 -0500
commite86bdc9707a469f70820bc2c5ec2c88d8b86e878 (patch)
tree6ca922704c8e220cd0bf30b0a93ce41b81d4f222 /doc/haunt.texi
parent63b6118cf488072cf2c106fc8d1557eb06255fc3 (diff)
doc: More explanations on sourcehut publisher.
* doc/haunt.texi (Sourcehut): hut cli configuration prequisites.
Diffstat (limited to 'doc/haunt.texi')
-rw-r--r--doc/haunt.texi12
1 files changed, 9 insertions, 3 deletions
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