Publish

Publish docs

Overview

Discover how to publish your documentation with ease, using the Publish button and exploring various customization options to enhance the look and feel of your published content.

To publish your documentation in DocsHound, start by clicking the publish button located at the top right corner of your screen. This button will take you through a simple but important setup process.

Initially, you'll be able to make your documentation stand out by personalizing it with several options:

Upload a product logo to make your guide instantly recognizable.
Decide if you want to show the Guide Label next to the logo. This option is great for logos that are more square and only contain an image.
Choose a font that matches your brand's style.
Select a brand color that will serve as an accent color throughout your guide, adding a consistent and visually appealing look.
Pick a display mode that reflects your preference or matches your brand identity best, including light, dark, or system-based settings.

After making these selections and clicking the Publish guide button, DocsHound will show you a preview version of your documentation portal.

For future updates, additional customization options become available, allowing you to further refine the look and feel of your published guide.

Advanced Customization

Domain Configuration

To attach a domain and make your guide live, follow a quick setup process. This will connect your custom domain to the published guide, making it accessible to your audience.

First, click on the Publish button located in the top right corner of the screen. In the Publish dialog, select the Domain tab to start the domain setup.

You'll need to enter the domain name you wish to use for your guide. Follow the instructions provided to update your domain's DNS settings. This involves adding a CNAME record pointing to DocsHound's hosting service.

After updating your DNS settings, it may take some time for changes to take effect. Once verified, your guide will be live and accessible through your custom domain.

Keep in mind, every time you publish, you can also customize other options, such as Open Graph details and portal meta, in the Publish dialog's additional tabs.

Meta and OpenGraph

When setting up the Basic Meta for your guide, you can customize how it appears on social media and in search results. This process involves choosing an OpenGraph image and a favicon. OpenGraph images help your documentation stand out when shared on social media, while the favicon is the small icon that appears in browser tabs and bookmarks.

DocsHound automatically generates OpenGraph images for your published articles, making it easier for you to maintain a professional and cohesive look across your documentation. This feature saves you time by eliminating the need to manually create and upload images for each article.

Publishing and Status

After you click on the Publish guide button, you'll see a preview version of your documentation portal. This preview lets you check how the guide will look before it goes live.

Manage Domain Settings

Disable custom domain: Click on the Disable custom domain button if you need to temporarily or permanently disable your custom domain.
Configure domain: Click on the Configure domain button to set up or change your custom domain settings.
Remove custom domain: If you want to remove the custom domain entirely, click on the Remove custom domain section.

Frequently Asked Questions

How do I upload a logo for my documentation?
To upload a logo, go to the Publish dialog. Here, you have the option to upload a product logo, which helps customize the look of your documentation.
Can I change the font in my guide?
Yes, you can change the font for your guide. When you open the Publish dialog for the first time, you'll be able to choose a font that matches your brand's style.
How to attach a domain to the published guide?
To attach a domain, go to the Domain tab in the Publish dialog. This step allows your guide to go live with a custom URL, making it easily accessible.
What steps should I follow to unpublish my guide?
To unpublish your guide, find the Status section in the Publish dialog. Here, you'll see an option to unpublish, which removes your guide from being accessible online.