# Documentation

- [genko.me basics](https://docs.genko.me/en/introduction.md): How workspaces, APIs, and content fit together, and where to start reading.
- [Quickstart](https://docs.genko.me/en/getting-started.md): Connect with the CLI, then show a post list, a detail page, and saved drafts with the SDK's List and View.
- User guide
  - [Introduction](https://docs.genko.me/en/support.md): A user guide for people who don't write code. It covers what you can do with genko.me and which page to read first.
  - [Sign in and take your first steps](https://docs.genko.me/en/support/first-login.md): How to sign up and sign in to genko.me, how to read the dashboard you see first, and what a workspace is.
  - [Write and publish an entry](https://docs.genko.me/en/support/write.md): From opening the editor to typing, saving, and switching between draft and published.
  - [Add images](https://docs.genko.me/en/support/images.md): How to put photos in the body or an image field, how to write alt text, and how to replace an image.
  - [Choose when to publish](https://docs.genko.me/en/support/schedule.md): How to publish at a set date and time, set when an entry stops showing, and check whether it's live right now.
  - [Invite people to work together](https://docs.genko.me/en/support/invite.md): How to create a team and invite members, and what Owners, Editors, and Viewers can do.
  - [When you need help](https://docs.genko.me/en/support/help.md): Common stumbling blocks and steps you can check on the spot, plus where to contact us if you can't solve it.
- Dashboard guide
  - [APIs and schemas](https://docs.genko.me/en/studio/apis.md): Choose an API format, create an API, and change its schema.
  - [Fields](https://docs.genko.me/en/studio/fields.md): Choose field types, set requirements, and design references.
  - [Integration blocks](https://docs.genko.me/en/studio/extensions.md): Add external maps, files, and embeds to entries and display their delivery values.
  - [Create and publish content](https://docs.genko.me/en/studio/content.md): Create entries, save drafts, publish, and edit published content.
  - [Import and export](https://docs.genko.me/en/studio/import-export.md): Import and export schemas and content as JSON or CSV, including migration from microCMS and Newt.
  - [Manage API keys](https://docs.genko.me/en/studio/api-keys.md): Issue, rotate, and delete delivery API keys and manage their validity periods.
  - [Manage media](https://docs.genko.me/en/studio/media.md): Upload, inspect, replace, and delete images and files.
  - [Version history](https://docs.genko.me/en/studio/revisions.md): Review and restore saved versions and understand retention limits.
  - [Workspace settings](https://docs.genko.me/en/studio/workspace-settings.md): Find workspace settings, change names and languages, and understand dashboard URLs.
  - [Teams and members](https://docs.genko.me/en/studio/teams.md): Create teams, invite members, assign roles, and manage team limits.
  - [Plans and limits](https://docs.genko.me/en/studio/plans.md): Compare Free, Plus, and Pro limits, shared storage, plan changes, and trials.
  - [Account and authentication](https://docs.genko.me/en/studio/account.md): Register, sign in, manage account settings, and delete an account.
  - [Notification settings](https://docs.genko.me/en/studio/notifications.md): Manage notification emails, security alerts, and API key expiry notices.
- Publishing and integrations
  - [Multilingual content](https://docs.genko.me/en/guides/multilingual-content.md): Create language versions in one API, and manage publishing and delivery for each language.
  - [Start with the announcements template](https://docs.genko.me/en/guides/announcements-starter.md): Try it with sample entries, then connect to genko.me and publish your own announcements site.
  - [Migrate from microCMS](https://docs.genko.me/en/guides/microcms-migration.md): Move your schema and content, then switch your connection target, images, and webhooks.
  - [Draft preview](https://docs.genko.me/en/guides/preview.md): Use the SDK's View to check saved drafts on your usual detail page.
  - [Scheduled publishing and unpublishing](https://docs.genko.me/en/guides/scheduled-publishing.md): Set a publication window with dates and times, and how delivery, webhooks, and caching are timed.
  - [Webhooks](https://docs.genko.me/en/guides/webhooks.md): Register a destination, verify signatures, and handle events, test sends, and delivery failures.
  - [Image transformation](https://docs.genko.me/en/guides/images.md): Resize, format, and quality options for image URLs, and when an image isn't transformed.
- SDK and CLI
  - [UI components](https://docs.genko.me/en/sdk/ui.md): Choose UI components for lists, content, and pagination in React, Vue, or Svelte.
  - [Display content with List and View](https://docs.genko.me/en/sdk/components.md): Build schema-based lists and detail views with states, pagination, and draft preview.
  - [Page views](https://docs.genko.me/en/sdk/page-views.md): Count views on your site, connect them to CMS entries, and see the results in genko.
  - [CLI reference](https://docs.genko.me/en/sdk/cli.md): CLI commands, generated files, overwrite behavior, and non-interactive use.
  - [Client configuration](https://docs.genko.me/en/sdk/client.md): Use the typed client generated by the CLI, configure it manually, or provide a custom fetch.
  - [Fetch content](https://docs.genko.me/en/sdk/fetching.md): Choose between list, single-item, object, and all-item retrieval, and handle 404 responses.
  - [Search and filter](https://docs.genko.me/en/sdk/queries.md): Use pagination, filters, reference expansion, and field selection with the SDK.
  - [Plugins and Next.js integration](https://docs.genko.me/en/sdk/plugins.md): Add preview, webhook revalidation, and custom plugins.
  - [Rich text and sharing components](https://docs.genko.me/en/sdk/react.md): Display rich text and sharing buttons, and adjust their props and styles.
- Frameworks and languages
  - Next.js
    - [Next.js](https://docs.genko.me/en/frameworks/next.md): Display genko.me entries in the Next.js App Router with List and View, preview drafts, and revalidate pages with webhooks.
    - [Get started](https://docs.genko.me/en/frameworks/next/getting-started.md): Connect genko.me to a Next.js App Router project and display a list and a single entry with List and View.
    - [Tutorial](https://docs.genko.me/en/frameworks/next/tutorial.md): Add pagination, saved draft previews, and cache revalidation with the nextRevalidate plugin to a Next.js site.
  - React
    - [React](https://docs.genko.me/en/frameworks/react.md): Display genko.me entries in a React app built with Vite, React Router, or CRA, and understand the limitations.
    - [Get started](https://docs.genko.me/en/frameworks/react/getting-started.md): Install the genko.me SDK in a React app and display a list and a single entry in the browser.
    - [Tutorial](https://docs.genko.me/en/frameworks/react/tutorial.md): Add pagination and draft previews to a React SPA without Next.js, and choose how content updates reach the app.
  - Nuxt
    - [Nuxt](https://docs.genko.me/en/frameworks/nuxt.md): Render genko.me entry lists and detail pages with Nuxt SSR, server routes, pagination, and draft previews.
    - [Get started](https://docs.genko.me/en/frameworks/nuxt/getting-started.md): Install @genko-me/vue in Nuxt, fetch through server routes, and render a list and a single entry with SSR.
    - [Tutorial](https://docs.genko.me/en/frameworks/nuxt/tutorial.md): Build pagination, saved draft previews, and webhook handling with Nuxt server routes.
  - Vue
    - [Vue](https://docs.genko.me/en/frameworks/vue.md): Display genko.me entry lists and detail pages in a Vite Vue SPA with @genko-me/vue, and understand the limitations.
    - [Get started](https://docs.genko.me/en/frameworks/vue/getting-started.md): Install @genko-me/vue in a Vite Vue app and fetch and display a list and a single entry in the browser.
    - [Tutorial](https://docs.genko.me/en/frameworks/vue/tutorial.md): Add pagination and draft previews to Vue without Nuxt, and choose how content updates reach the app.
  - SvelteKit
    - [SvelteKit](https://docs.genko.me/en/frameworks/sveltekit.md): Render genko.me lists and detail pages on the server with SvelteKit, including pagination and draft previews.
    - [Get started](https://docs.genko.me/en/frameworks/sveltekit/getting-started.md): Install @genko-me/svelte in SvelteKit and fetch in +page.server.ts to display a list and a single entry.
    - [Tutorial](https://docs.genko.me/en/frameworks/sveltekit/tutorial.md): Build pagination, saved draft previews, and webhook handling with SvelteKit server routes.
  - Svelte
    - [Svelte](https://docs.genko.me/en/frameworks/svelte.md): Display genko.me entry lists and detail pages in a Vite Svelte SPA, and understand the limitations.
    - [Get started](https://docs.genko.me/en/frameworks/svelte/getting-started.md): Install @genko-me/svelte in a Svelte SPA without SvelteKit and display a list and a single entry in the browser.
    - [Tutorial](https://docs.genko.me/en/frameworks/svelte/tutorial.md): Add pagination and draft previews to a Svelte SPA without SvelteKit, and choose how content updates reach the app.
  - Astro
    - [Astro](https://docs.genko.me/en/frameworks/astro.md): Render genko.me entry lists and details as static HTML in Astro with @genko-me/astro. No React, Vue, or Svelte needed.
    - [Get started](https://docs.genko.me/en/frameworks/astro/getting-started.md): Add @genko-me/astro to an Astro project, render a paginated list and a detail page with share buttons, and preview drafts.
    - [Tutorial](https://docs.genko.me/en/frameworks/astro/tutorial.md): Adjust the @genko-me/astro components, run draft previews, and rebuild the public site with webhooks.
  - Plain HTML
    - [Plain HTML](https://docs.genko.me/en/frameworks/html.md): Show genko.me entry lists and details in plain HTML with the framework-free @genko-me/wc custom elements, and understand their limitations.
    - [Get started](https://docs.genko.me/en/frameworks/html/getting-started.md): Add @genko-me/wc to plain HTML with an import map, then show a list and a single entry.
    - [Tutorial](https://docs.genko.me/en/frameworks/html/tutorial.md): Add pagination and draft previews with genko-pagination in plain HTML, then choose how to reflect content updates.
  - JavaScript
    - [JavaScript](https://docs.genko.me/en/frameworks/javascript.md): Fetch entries from genko.me with the SDK in Node.js or plain fetch, and decide when a delivery API key can be used in the browser.
    - [Get started](https://docs.genko.me/en/frameworks/javascript/getting-started.md): Connect to the genko.me delivery API from JavaScript and show a list and a single entry, using either the SDK or plain fetch.
    - [Tutorial](https://docs.genko.me/en/frameworks/javascript/tutorial.md): Implement pagination, preview saved drafts, and verify webhook signatures with JavaScript and genko.me.
  - PHP
    - [PHP](https://docs.genko.me/en/frameworks/php.md): Read genko.me entries from PHP using only cURL and json_decode(), without an official PHP package.
    - [Get started](https://docs.genko.me/en/frameworks/php/getting-started.md): Use PHP's curl_* functions to fetch a list and a single entry from genko.me and render them as HTML.
    - [Tutorial](https://docs.genko.me/en/frameworks/php/tutorial.md): Implement pagination, preview saved drafts, and verify webhook signatures with hash_hmac() in PHP.
  - Ruby
    - [Ruby](https://docs.genko.me/en/frameworks/ruby.md): Read genko.me entries from Ruby with net/http, and see where the delivery API fits in a Rails app.
    - [Get started](https://docs.genko.me/en/frameworks/ruby/getting-started.md): Use Ruby's standard net/http library to fetch a list and a single entry from genko.me and display them.
    - [Tutorial](https://docs.genko.me/en/frameworks/ruby/tutorial.md): Implement pagination, preview saved drafts, and verify webhook signatures with OpenSSL HMAC in Ruby.
  - Go
    - [Go](https://docs.genko.me/en/frameworks/go.md): Read genko.me entries from Go using only net/http and encoding/json.
    - [Get started](https://docs.genko.me/en/frameworks/go/getting-started.md): Use Go's net/http to fetch a list and a single entry from genko.me and decode them into structs.
    - [Tutorial](https://docs.genko.me/en/frameworks/go/tutorial.md): Implement pagination, preview saved drafts, and verify webhook signatures with crypto/hmac in Go.
- REST API
  - [Delivery API](https://docs.genko.me/en/api-reference/delivery.md): HTTP reference for authentication, and for fetching lists, single entries, objects, and the schema.
  - [OpenAPI and the API catalog](https://docs.genko.me/en/api-reference/openapi.md): URLs for the delivery API's OpenAPI 3.1 definition and the API catalog, and how to load them into tools.
  - [Query reference](https://docs.genko.me/en/api-reference/queries.md): Limits and examples for paging, filtering, search, sorting, reference expansion, and field selection.
  - [Response values](https://docs.genko.me/en/api-reference/values.md): Meta fields, the JSON shape of each field type, and how references, media, and integration blocks come back.
  - [Errors and limits](https://docs.genko.me/en/api-reference/errors.md): The cause behind each HTTP status, the API rate limit, and error handling in the SDK.
- For AI agents
  - [Working with AI agents](https://docs.genko.me/en/ai.md): When to use MCP, Markdown, or a Skill, and what information you give the AI.
  - [MCP server](https://docs.genko.me/en/ai/mcp.md): How to connect with OAuth to search the documentation and manage content.
  - [Skill](https://docs.genko.me/en/ai/skill.md): How to place working instructions in your project, and how updates and overwrites behave.
  - [Read as Markdown](https://docs.genko.me/en/ai/llms-txt.md): How to get llms.txt, the full-text file, and Markdown for a single page.
- [Troubleshooting](https://docs.genko.me/en/troubleshooting.md): Find a fix by symptom for connection, display, publishing, invitation, and media problems.
- Legal
  - [Terms of service](https://docs.genko.me/en/legal/terms.md): The terms of use for genko.me, published in Japanese.
  - [Privacy policy](https://docs.genko.me/en/legal/privacy.md): How genko.me handles user information.
  - [Third-party trademarks and logos](https://docs.genko.me/en/legal/trademarks.md): How genko.me shows the names and logos of connected services, published in Japanese.
  - [Legal notice (Japan)](https://docs.genko.me/en/legal/tokushoho.md): The business information notice required under Japan's Act on Specified Commercial Transactions, published in Japanese.

## Notes

- Every page link above is the absolute URL of the page's Markdown source.
- Drop the `.md` suffix for the HTML page (or send `Accept: text/markdown` to the HTML URL to get Markdown).
- Full text of every page: https://docs.genko.me/en/llms-full.txt
- OAuth-protected MCP server for documentation and content management: https://genko.me/mcp