SDK & Export API

What the SDK is, the three entry points, install, getting a key, and your first fetch.

Generate keys, account-scoping across workspaces, read-only access, CORS, and security.

Every createClient option: baseUrl, custom fetch, and requestInit for Next.js caching.

listArticles, listArticlesRaw, getArticleBySlug, getArticleById, and the low-level request.

Filter by workspaceId and status, limit results, and run incremental sync with since.

Field-by-field reference for article summaries, full articles, and response envelopes.

RankHikerError fields, the 404-to-null behavior, and handling 401, 5xx, and network errors.

Opt-in debug logging, the structured logger callback and RankHikerLogEvent shape, lifecycle hooks, url on errors, and the API-key safety guarantee.

Provider, useArticles and useArticle, BlogList and BlogPost, and a full client-side blog.

Plugin and provideRankHiker, reactive composables, components, slots, and a full SFC blog.

Server Components, ISR and no-store caching, generateStaticParams, and generateMetadata.

Use the core client with plain DOM, ESM and CommonJS, and Astro frontmatter.

The data-rankhiker hooks, an example stylesheet, class props, and full markup overrides.

An end-to-end recipe: shared client, list and detail pages, workspace scoping, and caching.