checkmd

command module
v0.0.0-...-fc1a6b1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 31, 2022 License: BSD-2-Clause Imports: 6 Imported by: 0

README

checkmd

Issue Tracker Docs Chat License

The checkmd tool parses Markdown files and reports common linter issues. It is mainly used to validate the documentation for mellium.im/xmpp.

If you'd like to contribute to the project, see CONTRIBUTING.md.

License

The package may be used under the terms of the BSD 2-Clause License a copy of which may be found in the file "LICENSE".

Unless you explicitly state otherwise, any contribution submitted for inclusion in the work by you shall be licensed as above, without any additional terms or conditions.

Documentation

Overview

The checkmd command parses Markdown documents and returns an error if any relative links or invalid URLs are found. Other tests may be added later.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL