1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
\==[doc] [2] [\bullet(packed)[\link[\1][\2]]]
\==[program] [3]
[\tablerow[\1 \version[\2]] [\release[\2]]
[\link[https://archives.eyrie.org/software/\3.tar.gz][tar.gz]
(\link[https://archives.eyrie.org/software/\3.tar.gz.asc]
[PGP signature])]
[\link[https://archives.eyrie.org/software/\3.tar.xz][tar.xz]
(\link[https://archives.eyrie.org/software/\3.tar.xz.asc]
[PGP signature])]]
\==[download] [3]
[\1 \version[\2]\break
\link[https://archives.eyrie.org/software/\3.tar.gz][tar.gz]
(\link[https://archives.eyrie.org/software/\3.tar.gz.asc]
[signature])\break
\link[https://archives.eyrie.org/software/\3.tar.xz][tar.xz]
(\link[https://archives.eyrie.org/software/\3.tar.xz.asc]
[signature])\break
Released \release[\2]]
\heading[DocKnot][software]
\h1[DocKnot]
\quote(short)[
Whenever you set out to do something, something else must be done
first.
][Murphy's Fourth Corollary][]
\div(sidebar)[
\h2[Download]
\download[DocKnot][docknot]
[devel/App-DocKnot-\version[docknot]]
\link[https://packages.debian.org/source/sid/docknot]
[Debian packages] \break
\link[https://archives.eyrie.org/software/ARCHIVE/App-DocKnot/]
[Archive]
\h2[Documentation]
\link[readme.html][General overview] \break
\link[news.html][Change summary] \break
\link[docknot.html][docknot manual page]
\h2[Development]
\link[todo.html][To-do list] \break
\link[https://github.com/rra/docknot]
[GitHub] \break
\link[https://github.com/rra/docknot/issues]
[Bug tracker] \break
\link[https://git.eyrie.org/?p=devel/docknot.git]
[Git repository] \break
\link[https://metacpan.org/release/App-DocKnot]
[MetaCPAN] \break
\link[https://tracker.debian.org/pkg/docknot]
[Debian package tracker] \break
]
\h2[Blurb]
DocKnot is a static web site generator built around a macro language
called thread, with special support for managing software releases. In
addition to building a web site, it can generate distribution tarballs and
consistent human-readable software package documentation from a YAML
metadata file and templates. The goal is to generate both web pages and
distributed documentation files (such as \code[README]) from the same
source, using templates for consistency across multiple packages.
\h2[Description]
In 1999, I wrote a program named \code[spin] that implemented an
idiosyncratic macro language called thread. It slowly expanded into a
static web site generator and gained additional features to manage the
journal entries, book reviews, RSS feeds, and software releases. DocKnot
is the latest incarnation.
In addition to its static web site generator, DocKnot can use one metadata
file as its source information and generate all the various bits of
documentation for a software package. This allows me to make any changes
in one place and then regenerate the web page, included documentation, and
other files to incorporate those changes. It also lets me make changes to
the templates to improve shared wording and push that out to every package
I maintain without having to remember track those changes in each package.
DocKnot is also slowly absorbing other tools that I use for software
distribution and web site maintenance, such as generating distribution
tarballs for software packages.
DocKnot was designed and written for my personal needs, and I'm not sure
it will be useful for anyone else. At the least, the template files are
rather specific to my preferences about how to write package
documentation, and the thread macro language is highly specialized for my
personal web site. I'm not sure if I'll have the time to make it a more
general tool. But you're certainly welcome to use it if you find it
useful, send pull requests to make it more general, or take ideas from it
for your own purposes.
\h2[Requirements]
Perl 5.24 or later and Module::Build are required to build this module.
The following additional Perl modules are required to use it:
\bullet(packed)[Date::Language (part of TimeDate)]
\bullet(packed)[Date::Parse (part of TimeDate)]
\bullet(packed)[File::BaseDir]
\bullet(packed)[File::ShareDir]
\bullet(packed)[Git::Repository]
\bullet(packed)[Image::Size]
\bullet(packed)[IO::Compress::Xz (part of IO-Compress-Lzma)]
\bullet(packed)[IO::Uncompress::Gunzip (part of IO-Compress)]
\bullet(packed)[IPC::Run]
\bullet(packed)[IPC::System::Simple]
\bullet(packed)[JSON::MaybeXS]
\bullet(packed)[Kwalify]
\bullet(packed)[List::SomeUtils 0.07 or later]
\bullet(packed)[Path::Iterator::Rule]
\bullet(packed)[Path::Tiny 0.101 or later]
\bullet(packed)[Perl6::Slurp]
\bullet(packed)[Pod::Thread 3.01 or later]
\bullet(packed)[Sort::Versions]
\bullet(packed)[Template (part of Template Toolkit)]
\bullet(packed)[YAML::XS 0.81 or later]
\h2[Download]
The distribution:
\table[][
\program[DocKnot][docknot]
[devel/App-DocKnot-\version[docknot]]
]
An \link[https://archives.eyrie.org/software/ARCHIVE/App-DocKnot/]
[archive of older releases] is also available.
DocKnot is packaged in Debian 11 (bullseye) and later as docknot. See the
\link[https://tracker.debian.org/pkg/docknot][Debian package tracker] for
more information.
DocKnot is available from CPAN as the
\link[https://metacpan.org/release/App-DocKnot] [App-DocKnot
distribution].
DocKnot is maintained using the Git version control system. To check out
the current development tree, see
\link[https://github.com/rra/docknot][GitHub] or clone:
\pre[ https://git.eyrie.org/git/devel/docknot.git]
Pull requests on GitHub are welcome. You can also
\link[https://git.eyrie.org/?p=devel/docknot.git][browse the current
development source].
\h2[Documentation]
\div(left)[
\class(first)[User documentation:]
\doc[readme.html][README]
\doc[news.html][Change summary]
\doc[docknot.html][docknot manual page]
\doc[license.html][License and copyright]
Developer documentation:
\doc[todo.html][To-do list]
\doc[https://github.com/rra/docknot]
[GitHub]
\doc[https://github.com/rra/docknot/issues]
[Bug tracker]
]
\div(right)[
\class(first)[API documentation:]
\doc[api/app-docknot.html][App::DocKnot]
\doc[api/app-docknot-command.html][App::DocKnot::Command]
\doc[api/app-docknot-config.html][App::DocKnot::Config]
\doc[api/app-docknot-dist.html][App::DocKnot::Dist]
\doc[api/app-docknot-generate.html][App::DocKnot::Generate]
\doc[api/app-docknot-release.html][App::DocKnot::Release]
\doc[api/app-docknot-spin.html][App::DocKnot::Spin]
\doc[api/app-docknot-spin-pointer.html][App::DocKnot::Spin::Pointer]
\doc[api/app-docknot-spin-rss.html][App::DocKnot::Spin::RSS]
\doc[api/app-docknot-spin-sitemap.html][App::DocKnot::Spin::Sitemap]
\doc[api/app-docknot-spin-thread.html][App::DocKnot::Spin::Thread]
\doc[api/app-docknot-spin-versions.html][App::DocKnot::Spin::Versions]
\doc[api/app-docknot-update.html][App::DocKnot::Update]
\doc[api/app-docknot-util.html][App::DocKnot::Util]
]
\h2(after)[License]
The DocKnot package as a whole is covered by the following copyright and
license:
\block[
Copyright 1999-2022
Russ Allbery <rra@cpan.org>
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
]
Some individual source files are covered by other, compatible licenses.
For complete copyright and license information, see the file
\link[license.html][LICENSE] in the DocKnot source distribution.
\signature
|
