What works as it is
You do not change the repository. Revdoku reads the same files:
| In the repository | On the Revdoku docs site |
|---|---|
docs.json or mint.json |
The navigation, with tabs, anchors, dropdowns, versions, languages and groups. A nested group becomes a group of its own. |
sidebarTitle |
The name of the page in the navigation |
title and description in the front matter |
The heading and the description at the top of the page |
snippets/ |
Not published as pages. Revdoku inserts a snippet where a page imports it, up to three levels deep. |
openapi in docs.json, in a tab or in the front matter (openapi: GET /plants) |
The OpenAPI reference pages, and the operation on a page |
logo and colors.primary |
The logo and the main color in the header |
These components become plain HTML: callouts, Callout, Update, Card, CardGroup, Columns, Tabs, CodeGroup, RequestExample, ResponseExample, Steps, Accordion, AccordionGroup, Expandable, Frame, ParamField and ResponseField.
What is different
- Components do not run code. A component that Revdoku does not know keeps only its text.
- If the docs have no home page, the address of the site opens the first page of the navigation.
- You choose one of three layouts: sidebar, notebook or minimal. Set
layoutindocs.json, or choose a layout when you publish. - The API console sends requests to the servers that your OpenAPI file lists. On a public site, the requests go through the site’s own proxy, so an API without CORS works.
Move in four steps
- Keep the repository as it is.
- Connect it to Revdoku. See Publish API docs from a GitHub repository.
- Publish the site, and compare its pages with your current docs at
https://<name>.revdoku.site. - Open the Domain page of the site and add your docs domain. Then change the DNS record of the domain as the page shows.
After the move, each push to the connected branch publishes the site again, and other branches get previews for 24 hours.
What each Revdoku docs site also has
- An MCP server at
/mcp,llms.txt,llms-full.txtand a Markdown copy of each page for AI agents. See Docs for AI agents. - Ask AI, and support tickets where a support agent drafts replies from your docs. See Support tickets.
- Analytics that show page views, searches, Ask AI questions and the AI agents that read your docs.
Start
Start free. You do not need a card.