Previewing and Publishing the Site
Previewing and publishing lets you see exactly how your documentation, changelog, and home pages will appear to visitors before they go live. When you're happy with the result, you can publish your changes to your public site with confidence.
How It Works
•Open a live preview of your docs, changelog, home page, and help center to see them rendered just as visitors will.
•Review formatting, layout, branding, and navigation in context before anything is made public.
•Publish your changes to push the latest content to your live, public-facing site.
•Access your site on the default Hyperdocs subdomain or your connected custom domain once published.
•Jump straight from the dashboard or editor to open the live site in a new view.
Steps
1.Open the editor and make the content changes you want across your docs, changelog, or home page.
2.Select the preview option to open a live view of the page you're working on.
3.Check that headings, text formatting, lists, images, branding, and navigation all appear the way you expect.
4.Return to the editor to fix anything that needs adjusting, then preview again.
5.When everything looks right, select Publish to make your changes available on the public site.
6.Open your live site on its Hyperdocs subdomain or custom domain to confirm the update is live.
What You Can Preview and Publish
Page Type | What You See in Preview |
|---|---|
Documentation | Pages and folders rendered with full formatting and your navigation structure. |
Changelog | Dated entries in chronological order with their tags, colors, and icons. |
Home Page | Your landing page with card-based blocks and applied branding. |
Help Center | The hero section and content blocks as visitors will experience them. |
Tips
•Preview after every significant change so you catch layout or formatting surprises early.
•Check both light and dark appearances if you've uploaded separate logos, so your branding looks right in each.
•Use the quick links on the dashboard to open the editor or jump straight to your live site.
Preview is the safest way to review changes — nothing you see in preview is visible to the public until you publish.
Your site is always available on its default Hyperdocs subdomain, even before you connect a custom domain.
Troubleshooting
•If your changes don't appear on the live site, confirm you selected Publish after saving your edits in the editor.
•If the live site still shows old content, refresh the page in your browser, as cached versions can linger briefly.
•If your custom domain isn't serving the site, check that the domain connection has been verified in your domain settings.
•If branding such as logos or accent color looks wrong in preview, revisit your general settings and confirm your uploads were saved.
Related topics: Connect a Custom Domain, Configure Branding and General Settings, Edit the Home Page.