summaryrefslogtreecommitdiff
path: root/README.md
Commit message (Collapse)AuthorAge
* Support POD conversion via *.spin pointersRuss Allbery2021-12-25
| | | | | | | | | | | | Support *.spin pointers in addition to *.rpod pointers for external POD files. The command-line flags used in *.rpod pointers are replaced by the title and options key of the *.spin file. *.rpod files are deprecated and support will be removed in a future version of DocKnot. Add spin_thread_output method to App::DocKnot::Spin::Thread, intended to convert thread to HTML as part of a conversion pipeline of a non-thread input file, while still using sitemap information and generating the page footer. DocKnot now depends on Path::Tiny.
* Fix localization of RSS datesRuss Allbery2021-09-14
| | | | | | Fix unintended localization of dates in RSS output, which are supposed to be RFC 2822 dates and therefore always use English month and day of week names. Thanks to Slaven Rezić for testing.
* Require Pod::Thread 3.00Russ Allbery2021-09-11
| | | | | | | We're dropping support for \id, so require a version of Pod::Thread that does not generate that command. Add versions to the cpanfile for CI.
* Update documentation for the merge of spinRuss Allbery2021-09-10
| | | | | | Update the overall package description to reflect that it's now primarily a static web site generator. Add Changes for the 5.00 release.
* Add spin-rss, rename spin-file to spin-threadRuss Allbery2021-09-10
| | | | | | | Add a spin-rss command to run App::DocKnot::Spin::RSS on a single file outside of recursive processing, and rename spin-file to spin-thread, setting up a convention for handling other types of conversion.
* Rework spin-rss as a moduleRuss Allbery2021-09-09
| | | | | | | | | | | Rename spin-rss to App::DocKnot::Spin::RSS, add an API, and update the documentation accordingly. Call App::DocKnot::Spin::Thread instead of running spin. Add a basic test for RSS and thread generation from .rss files. Call the new module instead of spin-rss from App::DocKnot::Spin. This has a few horrible hacks to deal with the working directory of thread spinning that will need a better solution later.
* Split off App::DocKnot::Spin::ThreadRuss Allbery2021-09-09
| | | | | | | Move the thread processing into its own module separate from the machinery to drive the recursive site generation. Update the documentation, remove duplicate documentation, and move the thread language documentation into App::DocKnot::Spin::Thread.
* Refactor the core spin parsing codeRuss Allbery2021-09-08
| | | | | | | | | Start the grand refactor of App::DocKnot::Spin. Refactor the core parsing code and move handling of macro definitions, string definitions and \\ into command handlers. Tag commands with whether they care about format arguments and remove a bunch of useless arguments to commands that take arguments but not a format string.
* Switch to Pod::Thread for POD renderingRuss Allbery2021-09-08
| | | | | | Rather than construct a command line for pod2thread, call Pod::Thread directly. Add the required version numbers for dependency modules to the documentation.
* Add App::DocKnot::Spin dependenciesRuss Allbery2021-09-06
| | | | | | Mention the App::DocKnot::Spin dependencies in Build.PL and the overall documentation. Make the Git::Repository dependency unconditional rather than working around its absence.
* Add test for Changes file formatRuss Allbery2021-03-27
| | | | Use Test::CPAN::Changes to check the format of the Changes file.
* Add Debian packaging to metadataRuss Allbery2021-02-27
|
* Don't explicitly depend on Pod::UsageRuss Allbery2021-02-27
| | | | | Pod::Usage comes with Perl core, so follow the normal convention of not calling out that dependency explicitly.
* Release 4.01Russ Allbery2021-02-27
|
* Fix alphabetization of IO::Uncompress::GunzipRuss Allbery2021-02-27
| | | | This comes after IO::Compress::Xz.
* Fix docknot --help, do some post-YAML cleanupRuss Allbery2021-02-27
| | | | | | | | | | | Remove the load_appdata_json helper function from App::DocKnot. This is no longer used now that all DocKnot data is in YAML. Properly depend on and import Pod::Usage so that docknot --help works. Correct the REQUIREMENTS sections of the module documentation to reflect new dependencies and the removal of a JSON dependency from most of DocKnot.
* Documentation updates for new featuresRuss Allbery2020-12-25
| | | | | | | Add App::DocKnot::Update to the API files, fix a bit more wording to reflect the new single metadata file layout, and add a note to the description that DocKnot generates distribution tarballs as well.
* Drop version number from README.mdRuss Allbery2020-12-24
| | | | | Drop the current version number from the title of README.md. This is not a common practice and doesn't seem to add much value.
* Drop support for support.cpanRuss Allbery2020-12-24
| | | | | | | | | | Drop support for the support.cpan metadata key, since the CPAN RT instance is going away. For packages with support.cpan set, if vcs.github was set and support.github was not, set support.github to match vcs.github during a docknot update. Change DocKnot to point to the GitHub issue tracker and make the same change to the affected test data.
* Change the metadata format to YAMLRuss Allbery2020-09-20
| | | | | | | | | | | | | | | | | | 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.)
* Release 3.05Russ Allbery2020-08-09
|
* Fix style issues found by Perl::Critic::FreenodeRuss Allbery2020-07-04
| | | | | | Ensure that style/critic tests pass with Perl::Critic::Freenode installed. This fixes build issues when testing with the perl-tester Docker image, which pre-installs that set of rules.
* Use List::SomeUtils and List::UtilRuss Allbery2020-07-04
| | | | | Replace List::MoreUtils with List::SomeUtils and List::Util, as recommended by Perl::Critic::Freenode.
* Depend on JSON::MaybeXS instead of JSONRuss Allbery2020-07-04
| | | | Recommended by Perl::Critic::Freenode.
* Release 3.04Russ Allbery2020-05-16
|
* Remove Travis-CI configurationRuss Allbery2020-02-29
| | | | Switch entirely to GitHub Actions workflows for CI.
* Add support for GitHub Actions workflowsRuss Allbery2020-02-29
| | | | | | | | | | | | | Change the vcs.travis metadata key to vcs.status.travis. This will require changes to all templates and package metadata.json files that use this key. Add support for generating a build status badge from a GitHub Actions workflow. To do this, set vcs.status.workflow to the name of the workflow that should be referenced for the badge. Also specify DocKnot's dependencies with a cpanfile. This makes it easier to install its dependencies with some tools, such as cpm.
* Release 3.03Russ Allbery2020-01-19
|
* Use Perl modules instead of gzip and xz programsRuss Allbery2020-01-17
| | | | | | | | docknot dist now uses IO::Uncompress::Gunzip and IO::Compress::Xz to generate a missing xz tarball rather than running external gzip and xz programs, which avoids test failures when those programs aren't available or don't support the expected options. Thanks to Slaven Rezić for the testing and report. (#131406)
* Remove unnecessary .svg from Shields.io badgeRuss Allbery2020-01-08
|
* Add license badge for CPAN packagesRuss Allbery2020-01-08
| | | | | For CPAN packages pushed to GitHub, add a license badge to the Markdown README file.
* Release 3.02Russ Allbery2020-01-08
|
* Generate xz-compressed tarballsRuss Allbery2020-01-05
| | | | | | If the native distribution generation commands create only a gzip-compressed tarball, generate an xz-compressed tarball from the gzip-compressed tarball during docknot dist.
* Release 3.01Russ Allbery2019-07-14
|
* Release 3.00Russ Allbery2019-06-29
|
* Improve docknot dist testRuss Allbery2019-06-26
| | | | | Use Capture::Tiny and File::Copy::Recursive to make the docknot dist test a bit simpler and easier to maintain.
* Add docknot dist commandRuss Allbery2019-06-26
| | | | | Add new docknot dist command and App::DocKnot::Dist module, which runs appropriate commands to create a distribution tarball.
* Release 2.00Russ Allbery2019-01-12
|
* Update the package description for module splitRuss Allbery2018-12-16
|
* Separate the testing section for Perl packagesRuss Allbery2018-12-16
| | | | | | | | | Separate the TESTING section from BUILD AND INSTALLATION for Perl modules in both README and README.md, and move the Lancaster instructions to that section. Add instructions for how to run a single test with Perl build systems. Test dependencies for Perl modules should now move into docs/metadata/test/suffix, the same as for packages with an Autoconf build system.
* Release 1.06Russ Allbery2018-08-31
|
* Release 1.05Russ Allbery2018-05-05
|
* Move Lancaster Consensus text into testing sectionRuss Allbery2018-04-29
| | | | | | | Move the description of Lancaster Consensus environment variables into the testing section of README and README.md instead of the requirements section, since they're more about running the tests and less about package requirements in general.
* Add badge and link for CPAN distributionRuss Allbery2018-04-28
| | | | | | Add a Status.io badge for the CPAN version to README.md and a link to metacpan.org in the thread output if the distribution.cpan key is set in metadata.json.
* Update DocKnot to Perl 5.24Russ Allbery2018-04-28
| | | | | | | Use the new postfix dereference syntax and update all of the Perl version requirements accordingly. Requires some tweaking to the Perl::Critic configuration due to a false positive with the new syntax.
* Add Travis-CI link and badgeRuss Allbery2018-04-28
| | | | | | Add the Travis-CI badge to README.md and a link to Travis-CI to the thread development links if the vcs.travis key is set in metadata.json.
* Release 1.04Russ Allbery2018-03-24
|
* Release 1.03Russ Allbery2018-03-17
|
* Add SPDX pointers to README and README.mdRuss Allbery2018-02-10
| | | | | | Add a paragraph to the license section of README and README.md saying that SPDX license identifiers are in use and providing a pointer to the SPDX license list.
* Release 1.02Russ Allbery2017-12-30
|
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-07 10:26:56 +0000