Documentation

Publish your project with a public URL

What you'll learn

  • Publish your entire project to a live, shareable URL with a single click.
  • Customize your documentation's appearance, including the URL slug, hero section, themes, and colors.
  • Configure settings for search engine indexing and site navigation.
  • Update your live documentation easily after making edits to your articles.

Publishing Your Documentation

Once your knowledge base is ready, you can make it accessible to your users by publishing it to a public URL. This process is straightforward and can be done in just a few steps.

  1. Click the three-dot menu next to your project name to open the Project Settings.
  2. In the settings modal, the Publishing section is shown by default.
  3. Click the Publish Documentation button to make your site live.
Documentation image

After publishing, the status will change to Published, and you will see options to View Live Site or Unpublish.

Customizing Your Public Site

Hinto provides a variety of options to customize the look and feel of your published documentation, ensuring it aligns with your brand. These settings are all found within the Project Settings modal.

  • General: Customize your URL Slug to create a branded link. You can also toggle Search Engine Indexing to control if your site appears in search results.
  • Hero Section: Edit the Title, Subtitle, and Description that appear at the top of your documentation's homepage.
  • Themes & Colors: Choose between light and dark modes, upload custom logos, set your brand's primary and secondary colors, and select from a variety of fonts.
  • Navigation: Add custom links to your site's header and footer to direct users to other resources.
Documentation image

Updating Your Live Documentation

As you make changes to your articles, you'll need to push those updates to your live site. Hinto makes this process simple.

  1. After editing an article, click the Save changes button at the top right.
  2. A Republish button will appear in the left sidebar under the published link.
  3. Click Republish to update your live documentation with the latest changes.
Documentation image

Now you try

Apply what you've learned by publishing and customizing your own project.

  1. Open one of your projects and navigate to Project Settings.
  2. Click Publish Documentation.
  3. In the Themes & Colors tab, choose a new Primary Color that matches your brand.
  4. Click View Live Site to see your customized documentation.
  5. Return to the editor, make a small change to any article, save it, and click the Republish button to see your update go live.

Summary

In this lesson, you learned how to publish your knowledge base and make it available to the world. You also explored the powerful customization options that allow you to tailor the URL, appearance, and navigation of your public site to create a professional, on-brand experience for your users. Finally, you saw how easy it is to keep your documentation current with the one-click republish feature.