App-DocKnot
view release on metacpan or search on metacpan
t/data/spin/output/software/docknot/readme.html view on Meta::CPAN
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>DocKnot %VERSION%</title>
<link rel="stylesheet" href="/~eagle/styles/faq.css" type="text/css" />
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rel="up" href="./" title="DocKnot" />
<link rel="top" href="../../" />
</head>
<!-- Converted by DocKnot %VERSION% on %DATE% -->
<body>
<table class="navbar"><tr>
<td class="navleft"></td>
<td>
<a href="../../">Russ Allbery</a>
> <a href="../">Software</a>
> <a href="./">DocKnot</a>
</td>
<td class="navright"></td>
</tr></table>
<h1>DocKnot %VERSION%</h1>
<p class="subheading">
(Static web site and documentation generator)<br />
Maintained by Russ Allbery <rra@cpan.org>
</p>
<p>
Copyright 1999-2022 Russ Allbery <rra@cpan.org>. This software is
distributed under a BSD-style license. Please see the section LICENSE
below for more information.
</p>
<h2>BLURB</h2>
<p>
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 README) from the same source,
using templates for consistency across multiple packages.
</p>
<h2>DESCRIPTION</h2>
<p>
In 1999, I wrote a program named 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.
</p>
<p>
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
( run in 0.821 second using v1.01-cache-2.11-cpan-39bf76dae61 )