Previewing Articles
We all want our docs to look just right. If you're writing or editing an article and you want to check how it looks on your HelpDocs before publishing it, you can preview it from the article editor. 👀
We all want our docs to look just right. Previewing lets you see exactly how your article will appear to visitors before you publish it.
This is super handy when you're tweaking formatting, checking how images display, or making sure your content flows well. Think of it as a test drive for your articles.
Why Preview Matters
Here are some common scenarios where preview comes in clutch:
- Formatting checks: Make sure your headings, lists, and spacing look good
- Image verification: Confirm images display at the right size and position
- Content flow: Read through your article as your customers would see it
- Link testing: Check that buttons and links appear correctly
- Template testing: See how your content looks with your Knowledge Base theme
- Mobile preview: Resize your browser to check how it looks on different devices
Previewing a Draft Article
When you're working on a new article or editing an existing one, you can preview it anytime after saving.
- In the article editor make sure you've saved your latest changes
- Hit the Preview button in the upper right corner of the article editor
- Done! You'll see how your article looks on your Knowledge Base 🎉
The preview opens in the same tab. You can navigate back to the editor using your browser's back button or by clicking Edit Article if that option appears.
Preview Tips and Best Practices
Here are some ways to get the most out of preview:
- Save often: Get in the habit of saving before previewing so you don't lose work
- Test on different screen sizes: Resize your browser to see how content looks on tablets and phones
- Read it out loud: Preview mode is great for catching typos and awkward phrasing
- Check all your links: Click through buttons and links to make sure they work
- Get a second opinion: Share the preview URL with teammates for quick feedback
Quick Notes
A few things to keep in mind:
- Preview doesn't publish your article. You're the only one who can see it
- The [Unsaved] tag only appears when you have unsaved changes
- Draft articles won't appear in your Knowledge Base search until they're published
- If you're previewing a draft article it won't show up in your site navigation
Preview is your safety net. Use it liberally to make sure everything looks perfect before your customers see it.
What did you think of this doc?
Understanding Search Results
Switching the Editor Mode