summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRuss Allbery <rra@cpan.org>2020-09-20 00:14:40 -0700
committerRuss Allbery <rra@cpan.org>2020-09-20 00:16:39 -0700
commitf52c1c24e19ea9a728292b099ff975927ec3f731 (patch)
tree213f1f72c22272a9c3033c1740602605df266a56 /README.md
parente2be047abb4bc7873ac9307f576cf9e514c133ac (diff)
Change the metadata format to YAML
Change the metadata format to a single YAML file, with a slightly different internal representation, whose default location is docs/docknot.yaml. The new docknot update command (or the App::DocKnot::Update module) will convert from the old JSON format. The new metadata format is checked against a schema when read. DocKnot now depends on YAML::XS and Kwalify. Word wrap numeric lists and, in Markdown output, quoted paragraphs. Previously these preserved the original spacing from the input text snippets. Require paragraphs be indented by at least six spaces, not five, to be treated as verbatim paragraphs and left unwrapped. (Markdown paragraphs can still use four spaces because they are wrapped in markup lines.)
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/README.md b/README.md
index 49fabb8..4b63c49 100644
--- a/README.md
+++ b/README.md
@@ -13,11 +13,11 @@ distributed under a BSD-style license. Please see the section
## Blurb
DocKnot is a system for generating consistent human-readable software
-package documentation from metadata files and templates. The metadata is
-primarily JSON files, but can include files of documentation snippets.
-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.
+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. DocKnot also automates generating distribution
+tarballs for software packages.
## Description
@@ -63,9 +63,11 @@ The following additional Perl modules are required to use it:
* IPC::Run
* IPC::System::Simple
* JSON::MaybeXS
+* Kwalify
* List::SomeUtils
* Perl6::Slurp
* Template (part of Template Toolkit)
+* YAML::XS
## Building and Installation