Shareable Private Link
A Shareable Private Link lets you share a specific documentation page with anyone using a secret URL — even if that page is not published on your public site. The link is tied to a unique token, so only people who have the URL can open the page. You can revoke the link at any time to cut off access instantly.
How It Works
When you create a Shareable Private Link for a page, Hyperdocs generates a unique token and attaches it to that page. Anyone who visits the resulting URL can read the page regardless of whether it is live on your public documentation site. The link is per-page — each page has its own independent token. Revoking the link destroys the token, and the URL immediately stops working.
Shareable Private Links also work for translated pages. If you are editing a page in a non-English language, you can generate a separate private link scoped to that translated version without affecting the English page or any other language..
Use Cases
Shareable Private Links are useful in several situations where you need to give someone access to a page without making it fully public:
•Early review before publishing — share a draft page with a teammate, stakeholder, or subject-matter expert so they can review and give feedback before the page goes live on your public site.
•Customer-specific content — share a page that covers a feature or configuration relevant only to a specific customer or partner, without exposing it to all visitors.
•Internal documentation — keep certain pages off the public site permanently and distribute them only via private links to internal team members.
•Translation review — share a translated page with a native-language reviewer before publishing the translation publicly, using the locale-scoped private link.
•Time-limited access — share a page temporarily and revoke the link once the review period or need has passed, without having to delete or unpublish the page itself.
Creating a Shareable Private Link
•Open the documentation editor from your admin dashboard and navigate to the page you want to share.
•Open the share panel for that page. The Sharable Private Link section appears inside the panel, showing a description: Anyone with the link can open this page, even while it's hidden from the public site.
•Click Create link. Hyperdocs generates a unique token and builds the shareable URL for that page.
•The URL appears in a read-only field. Click the field to select the full URL, or click the copy button to the right of the field to copy it to your clipboard.
•Share the copied URL with whoever needs access. They can open the page in any browser without logging in to Hyperdocs.
Copying the Link
Once a link has been created, the URL is shown in a read-only field in the Sharable Private Link section. You can retrieve it at any time by reopening the share panel for that page.
•Click the copy button to the right of the URL field to copy the link to your clipboard. The button briefly shows a checkmark to confirm the copy was successful.
•Alternatively, click into the URL field — it selects the full URL automatically — then use your keyboard shortcut to copy.
Revoking a Shareable Private Link
Revoking a link destroys its token. Anyone who tries to visit the old URL after revocation will no longer be able to access the page. The page itself is not deleted or changed — only the private link is removed.
•Open the share panel for the page that has an active private link.
•Click the revoke button (the trash icon) to the right of the URL field.
•The link is removed immediately. The URL field and copy button disappear, and the section returns to its initial state with the Create link button.
•If you need to share the page again in the future, click Create link to generate a new token. The new URL will be different from the revoked one.
Shareable Private Links for Translated Pages
If you are working on a translated version of a page, the Sharable Private Link section in the share panel generates a link scoped to that specific language. Creating or revoking a private link for a translated page does not affect the English page's link or any other language's link. Each language version of a page has its own independent token.
Role-Based Access
•Admins and Editors can create and revoke Shareable Private Links.
•Viewers can see the share panel and the active URL if a link already exists, but the Create link and revoke buttons are not available to them.
