content-query 0.0.1 → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Yangshun Tay
+
+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,70 @@
+# ContentQuery
+
+Typed collections and queries for Markdown, JSON, YAML, and TOML. ContentQuery validates your content at build time and produces portable data your application can query and render on the server.
+
+Use it with your existing framework. Your application owns its routes, layouts, and public URLs; production reads prepared content without loading the original source files.
+
+## Features
+
+- **Typed schemas.** Validate metadata with bundled schema builders or any Standard Schema V1 provider, with inferred TypeScript types.
+- **Flexible sources.** Load local files, use Astro-compatible content loaders, or write your own loader.
+- **Queries and relationships.** Select fields, filter, sort, paginate, and load related entries with validated references.
+- **Markdown rendering.** Get HTML, headings, and syntax highlighting separately from metadata queries.
+- **Framework integrations.** Use Vite, Next.js, or the standalone CLI, with content updates during development.
+
+## Usage
+
+Requires Node.js 22.12 or later. Install ContentQuery:
+
+```sh
+npm install content-query
+```
+
+Define `content-query.config.ts`:
+
+```ts
+import { defineCollection } from "content-query";
+import { schema } from "content-query/schema";
+
+export const collections = {
+  posts: defineCollection({
+    source: "./content/posts",
+    schema: schema.object({
+      title: schema.string(),
+      draft: schema.boolean().default(false),
+    }),
+  }),
+};
+```
+
+Add Markdown files with `title` frontmatter under `content/posts/`, then build:
+
+```sh
+npx content-query build
+```
+
+Query the generated module from server code:
+
+```ts
+import { content } from "./.content-query/server.js";
+import { eq } from "content-query/query";
+
+const posts = await content
+  .select("id", "title")
+  .from("posts")
+  .where((fields) => eq(fields.draft, false))
+  .orderBy("title");
+```
+
+Add `.content-query/` to `.gitignore`. Follow the quick start for a complete walkthrough, or choose a framework example below.
+
+## Documentation
+
+- [Quick start](https://github.com/yangshun/content-query/blob/main/website/content/guides/quick-start.md)
+- [Framework examples](https://github.com/yangshun/content-query/blob/main/examples/README.md)
+- [API and usage](https://github.com/yangshun/content-query/blob/main/docs/API.md)
+- [Guides and reference](https://github.com/yangshun/content-query/blob/main/docs/README.md)
+
+The Vite integration supports Vite 8, and the Next.js integration supports Next.js 16. Both integrations are optional; standalone builds and queries require neither framework.
+
+Released under the [MIT license](https://github.com/yangshun/content-query/blob/main/LICENSE).