@markdown-for-agents/hono 0.1.1 → 0.1.2

package/README.md

@@ -0,0 +1,77 @@
+# @markdown-for-agents/hono
+
+Hono middleware for [markdown-for-agents](https://www.npmjs.com/package/markdown-for-agents) — a runtime-agnostic HTML to Markdown converter built for AI agents.
+
+Add one line to your Hono app and AI agents get clean, token-efficient Markdown instead of HTML. Normal browser requests pass through untouched.
+
+## How it works
+
+The middleware uses content negotiation. When a client sends `Accept: text/markdown`, HTML responses are automatically converted to Markdown. The response includes:
+
+- `Content-Type: text/markdown; charset=utf-8`
+- `x-markdown-tokens` header with the token count
+
+## Install
+
+```bash
+npm install @markdown-for-agents/hono markdown-for-agents
+```
+
+## Usage
+
+```ts
+import { Hono } from 'hono';
+import { markdown } from '@markdown-for-agents/hono';
+
+const app = new Hono();
+app.use(markdown({ extract: true }));
+
+app.get('/', c => {
+    return c.html('<h1>Hello</h1>');
+});
+
+export default app;
+```
+
+```bash
+# Normal HTML response
+curl http://localhost:3000
+
+# Markdown response for AI agents
+curl -H "Accept: text/markdown" http://localhost:3000
+```
+
+## Options
+
+Accepts all [`markdown-for-agents` options](https://www.npmjs.com/package/markdown-for-agents#options):
+
+```ts
+app.use(
+    markdown({
+        // Strip nav, ads, sidebars, cookie banners
+        extract: true,
+
+        // Resolve relative URLs
+        baseUrl: 'https://example.com',
+
+        // Remove duplicate content blocks
+        deduplicate: true,
+
+        // Custom token counter (e.g. tiktoken)
+        tokenCounter: text => ({ tokens: enc.encode(text).length, characters: text.length, words: text.split(/\s+/).filter(Boolean).length })
+    })
+);
+```
+
+## Other frameworks
+
+| Package                                                                                      | Framework                                    |
+| -------------------------------------------------------------------------------------------- | -------------------------------------------- |
+| [`@markdown-for-agents/express`](https://www.npmjs.com/package/@markdown-for-agents/express) | Express                                      |
+| [`@markdown-for-agents/fastify`](https://www.npmjs.com/package/@markdown-for-agents/fastify) | Fastify                                      |
+| [`@markdown-for-agents/nextjs`](https://www.npmjs.com/package/@markdown-for-agents/nextjs)   | Next.js                                      |
+| [`@markdown-for-agents/web`](https://www.npmjs.com/package/@markdown-for-agents/web)         | Web Standard (Cloudflare Workers, Deno, Bun) |
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@markdown-for-agents/hono",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Hono middleware for markdown-for-agents",
   "type": "module",
   "sideEffects": false,
@@ -20,7 +20,7 @@
   "main": "./dist/index.mjs",
   "types": "./dist/index.d.mts",
   "dependencies": {
-    "markdown-for-agents": "0.1.1"
+    "markdown-for-agents": "0.1.2"
   },
   "peerDependencies": {
     "hono": ">=4.0.0"