diff options
| -rw-r--r-- | README | 6 | ||||
| -rw-r--r-- | README.md | 6 | ||||
| -rw-r--r-- | docs/docknot.yaml | 8 | ||||
| -rw-r--r-- | t/data/generate/docknot/output/thread | 7 |
4 files changed, 23 insertions, 4 deletions
@@ -26,7 +26,7 @@ DESCRIPTION version of README as well, avoiding the ugly text rendering on the GitHub page for a package. - This package uses one metadata directory as its source information and + This package uses one metadata file as its source information and generates all the various bits of documentation for a package. This allows me to make any changes in one place and then just regenerate the web page, included documentation, and other files to incorporate those @@ -34,6 +34,10 @@ DESCRIPTION shared wording and push that out to every package I maintain during its next release, without having to remember which changes I wanted to make. + 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 @@ -30,7 +30,7 @@ straw was when GitHub became popular and I wanted to provide a Markdown version of `README` as well, avoiding the ugly text rendering on the GitHub page for a package. -This package uses one metadata directory as its source information and +This package uses one metadata file as its source information and generates all the various bits of documentation for a package. This allows me to make any changes in one place and then just regenerate the web page, included documentation, and other files to incorporate those @@ -38,6 +38,10 @@ changes. It also lets me make changes to the templates to improve shared wording and push that out to every package I maintain during its next release, without having to remember which changes I wanted to make. +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 diff --git a/docs/docknot.yaml b/docs/docknot.yaml index 8595021..6e756d8 100644 --- a/docs/docknot.yaml +++ b/docs/docknot.yaml @@ -58,6 +58,8 @@ docs: title: App::DocKnot::Dist - name: api/app-docknot-generate title: App::DocKnot::Generate + - name: api/app-docknot-update + title: App::DocKnot::Update user: - name: docknot title: docknot manual page @@ -80,7 +82,7 @@ description: | Markdown version of `README` as well, avoiding the ugly text rendering on the GitHub page for a package. - This package uses one metadata directory as its source information and + This package uses one metadata file as its source information and generates all the various bits of documentation for a package. This allows me to make any changes in one place and then just regenerate the web page, included documentation, and other files to incorporate those @@ -88,6 +90,10 @@ description: | shared wording and push that out to every package I maintain during its next release, without having to remember which changes I wanted to make. + 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 diff --git a/t/data/generate/docknot/output/thread b/t/data/generate/docknot/output/thread index 81313f6..4d39ac3 100644 --- a/t/data/generate/docknot/output/thread +++ b/t/data/generate/docknot/output/thread @@ -69,7 +69,7 @@ last straw was when GitHub became popular and I wanted to provide a Markdown version of \code[README] as well, avoiding the ugly text rendering on the GitHub page for a package. -This package uses one metadata directory as its source information and +This package uses one metadata file as its source information and generates all the various bits of documentation for a package. This allows me to make any changes in one place and then just regenerate the web page, included documentation, and other files to incorporate those @@ -77,6 +77,10 @@ changes. It also lets me make changes to the templates to improve shared wording and push that out to every package I maintain during its next release, without having to remember which changes I wanted to make. +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 @@ -165,6 +169,7 @@ development source]. \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-update.html][App::DocKnot::Update] ] \h2(after)[License] |