docmeta 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 docmeta contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,61 @@
+# docmeta
+
+Validate the **presence and format** of document metadata against **JSON Schema** — built for CI.
+
+<!-- badges: add npm version, build status, and license badges here -->
+
+`docmeta` checks the metadata in your documents — Markdown frontmatter and more — against one or more JSON Schemas. It verifies that required fields are present and correctly formatted (a `type`, an ISO 8601 `timestamp`, a URI `resource`); it does not judge prose quality. It ships with the [Open Knowledge Format (OKF)](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md) schema built in, follows [clig.dev](https://clig.dev) conventions, and returns a nonzero exit code (plus optional GitHub annotations) when validation fails.
+
+## Install
+
+```bash
+npm install -g docmeta
+# or run it without installing:
+npx docmeta validate "**/*.md"
+```
+
+Requires Node.js 24 or later.
+
+## Quick start
+
+Point `docmeta validate` at a file, a directory (walked recursively), or a glob. With no `--schema`, it validates against the built-in OKF schema.
+
+```bash
+docmeta validate docs/intro.md
+```
+
+```text
+✗ docs/intro.md
+    (root)      must have required property 'type'   (line 1)  [google:okf:0.1]
+    /timestamp  must match format "date-time"        (line 9)  [google:okf:0.1]
+
+1 file checked, 0 passed, 1 failed, 0 errors
+```
+
+A clean run exits `0`; validation failures exit `1`; operational errors (no input, unknown schema, parse error) exit `2`.
+
+## Supported formats
+
+Markdown, MDX, AsciiDoc, reStructuredText, XML, and HTML. Run `docmeta schemas` to list the built-in schemas and every supported format.
+
+## Documentation
+
+Full guides, recipes, and reference live on the documentation site:
+
+**https://hawkeyexl.github.io/docmeta/**
+
+| Track | What it covers |
+|-------|----------------|
+| [Get started](https://hawkeyexl.github.io/docmeta/get-started/) | Install and run your first validation. |
+| [Set up validation](https://hawkeyexl.github.io/docmeta/set-up/) | Stand up validation for a repo: `docmeta.config.yaml`, per-folder schema overrides. |
+| [Run it in CI](https://hawkeyexl.github.io/docmeta/ci/) | GitHub Actions and other CI recipes, exit codes, and PR annotations. |
+| [Define & evolve schemas](https://hawkeyexl.github.io/docmeta/schemas/) | Author a schema, wire up resolution, and version it without breaking the build. |
+| [Reference](https://hawkeyexl.github.io/docmeta/reference/cli/) | Every CLI flag, config key, the schema-resolution precedence chain, and output formats. |
+
+## Contributing
+
+Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for dev setup, the test loop, and how to add support for a new input format.
+
+## License
+
+[MIT](LICENSE)