Part of internal documentation published to the public through a branded storefront window

Publish API documentation on your own public domain

Your internal documentation is for your team. Sometimes part of it has to be public: the API that customers and partners integrate with, a developer portal, an open product. SelfDocHub can publish selected services as a public site on your own domain, with your colors and logo, without a sign-in and without a second documentation tool to keep in step.

Publish only what you choose#

You pick the services, and inside them the tags and endpoints, for every published version. Each service is taken at a service version you choose, with or without your Markdown overlays, and with request and response examples only if you want them, because examples can hold secrets. The result is a frozen copy: later edits, deleted services and revoked tokens do not change what readers see until you publish again. Environments, tokens, saved requests and notes never get into the copy.

Versions that go live when you decide#

A new version starts hidden. Open it with a short-lived preview link, read it as your customers will, and then show it. Versions can be reordered, hidden again, renamed and changed service by service, so a release can ship with the docs of the previous one still online. The first visible version is the default one that the site opens.

A site that looks like yours#

A style defines the whole look: ready-made light and dark palettes with any color overridable, saved palettes shared between sites, fonts, corner radius and content width, your logos and favicon, a top bar with its own links and a footer with link blocks, a copyright line and bottom links. The reader chooses a light, dark or automatic theme. Colors are checked and low contrast is reported, so a style cannot break the page.

Several domains, one portal#

The site is drawn by self-doc-hub-portal, a Nuxt application with server-side rendering, so pages are fast and readable by search engines, with a sitemap and a robots file. One portal installation serves several domains, each with its own style and versions. Behind it all is a read-only public API with caching and rate limits, which you can also call from your own site.

Try it#

See a live example at docs.demo.selfdochub.com: the three demo services of the SelfDocHub demo, published with a custom style.

Plans and limits#

Documentation publishing is part of the Team plan (1 domain, 5 versions per domain), the Business plan (5 domains, 20 versions per domain) and the Unlimited plan. Reaching a limit only stops you from adding more: existing domains and versions are never deleted. Start with Public Documentation Site and Deploy the Public Site in the documentation.

Frequently asked questions

Do readers have to sign in?

No. The public site is open to everyone who has the address. The documentation inside your SelfDocHub stays behind your own sign-in and roles.

Can the public see my internal services and secrets?

Only what you choose. A published version is a frozen copy of the services, endpoints and pages you select. Environments, tokens, saved requests and notes never get into it, and request and response examples are left out unless you switch them on.

Can I check a version before it goes live?

Yes. A new version starts hidden. Open it with a preview link that works for one hour, and show it when it looks right.

Do I need another server?

The site is drawn by a small Nuxt application, self-doc-hub-portal, that you run with Docker next to SelfDocHub. One installation can serve several domains.

Which plans include it?

Team (1 domain, 5 versions per domain), Business (5 domains, 20 versions per domain) and Unlimited (no limits). It is not part of the Free plan.

Run it on your own infrastructure

The Free plan includes a license for one installation. Start with Docker in a few minutes, no credit card needed.