vlt / affordances
  • Quickstart
  • Concepts
  • Guides
  • Reference
  • Overview
    • Overview
    • @affordances/md
    • @affordances/md/next
    • @affordances/md/react
    • Reference
  • Type Aliases
  • Config
  • Has
  • LlmsFullOptions
  • LlmsLink
  • LlmsTxtOptions
  • MdHandlerOptions
  • Pages
  • Rewrite
  • Rewrites
  • Variables
  • GET
  • MD_PATH
  • RENDER_HEADER
  • rewrites
  • Functions
  • createLlmsFullHandler()
  • createLlmsTxtHandler()
  • createMdHandler()
  • md()
  • mdAlternate()
  • withMd()
  1. Reference
  2. /
  3. API reference
  4. /
  5. @affordances/md
  6. /
  7. @affordances/md/next

@affordances/md/next

Type Aliases

Config

TypeScript
type Config = object;

Properties

rewrites?
TypeScript
rewrites?: () => Promise<unknown> | unknown;
Returns

Promise<unknown> | unknown


Has

TypeScript
type Has = object;

Properties

key
TypeScript
key: string;
type
TypeScript
type: "header" | "query";
value?
TypeScript
value?: string;

LlmsFullOptions

TypeScript
type LlmsFullOptions = Omit<MdHandlerOptions, "append"> & object;

Type Declaration

NameType
pages?Pages

LlmsLink

TypeScript
type LlmsLink = 
  | string
  | {
  description?: string;
  title: string;
  url: string;
};

LlmsTxtOptions

TypeScript
type LlmsTxtOptions = Omit<MdHandlerOptions, "append"> & object;

Type Declaration

NameType
full?string | false
intro?string
sections()?(request, routes) => object[] | Promise<object[]>
summary?string
title?string

MdHandlerOptions

TypeScript
type MdHandlerOptions = object;

Properties

append?
TypeScript
append?: (request) => Promise<string | undefined> | string | undefined;
Parameters
ParameterType
requestRequest
Returns

Promise<string | undefined> | string | undefined

maxBytes?
TypeScript
maxBytes?: number;
origin?
TypeScript
origin?: string;
timeout?
TypeScript
timeout?: number;

Pages

TypeScript
type Pages = (request, routes) => string[] | Promise<string[]>;

Parameters

ParameterType
requestRequest
routesstring[]

Returns

string[] | Promise<string[]>


Rewrite

TypeScript
type Rewrite = object;

Properties

destination
TypeScript
destination: string;
has?
TypeScript
has?: Has[];
missing?
TypeScript
missing?: Has[];
source
TypeScript
source: string;

Rewrites

TypeScript
type Rewrites = object;

Properties

afterFiles
TypeScript
afterFiles: Rewrite[];
beforeFiles
TypeScript
beforeFiles: Rewrite[];
fallback
TypeScript
fallback: Rewrite[];

Variables

GET

TypeScript
const GET: (request) => Promise<Response>;

Parameters

ParameterType
requestRequest

Returns

Promise<Response>


MD_PATH

TypeScript
const MD_PATH: "/api/affordances/md" = '/api/affordances/md';

RENDER_HEADER

TypeScript
const RENDER_HEADER: "x-affordances-md-render" = 'x-affordances-md-render';

rewrites

TypeScript
const rewrites: object;

Type Declaration

NameType
afterFilesobject[]
beforeFilesobject[]

Functions

createLlmsFullHandler()

TypeScript
function createLlmsFullHandler(__namedParameters?): (request) => Promise<Response>;

Parameters

ParameterType
__namedParameters?LlmsFullOptions

Returns

(request) => Promise<Response>


createLlmsTxtHandler()

TypeScript
function createLlmsTxtHandler(__namedParameters?): (request) => Promise<Response>;

Parameters

ParameterType
__namedParameters?LlmsTxtOptions

Returns

(request) => Promise<Response>


createMdHandler()

TypeScript
function createMdHandler(__namedParameters?): (request) => Promise<Response>;

Parameters

ParameterType
__namedParameters?MdHandlerOptions

Returns

(request) => Promise<Response>


md()

TypeScript
function md(): <C>(config) => C;

Returns

<C>(config) => C


mdAlternate()

TypeScript
function mdAlternate(path): object;

Parameters

ParameterType
pathstring

Returns

object

NameType
typesobject
types.text/markdownstring

withMd()

TypeScript
function withMd<C>(config): C;

Type Parameters

Type Parameter
C extends Config

Parameters

ParameterType
configC

Returns

C


Previous@affordances/mdNext@affordances/md/react

On this page

  • Type Aliases
  • Config
  • Has
  • LlmsFullOptions
  • LlmsLink
  • LlmsTxtOptions
  • MdHandlerOptions
  • Pages
  • Rewrite
  • Rewrites
  • Variables
  • GET
  • MD_PATH
  • RENDER_HEADER
  • rewrites
  • Functions
  • createLlmsFullHandler()
  • createLlmsTxtHandler()
  • createMdHandler()
  • md()
  • mdAlternate()
  • withMd()

Make your app agent-operable

Give every page a graph and every server action an agent path: HTTP, WebMCP, and MCP, with the same session and the same checks. One command sets it up.

Read the quickstart