Beacon Embedded Articles
Provide instant answers with Embedded Articles. Showcase helpful information from Docs articles as side-by-side guides, inline informational pop-ups, or in-the-moment modal takeovers with just a simple snippet of HTML.
To get started with Embedded Articles, you must have a Beacon embedded on your site. Not there yet? Check out our how-to guide to get started with Beacon: Create a New Beacon
Once you've created and embedded a Beacon on your website, choose from one of four choices for Embedded Articles:
- Use the data-beacon-article attribute to open the article in Beacon, just normal style.
- Use the data-beacon-article-inline attribute to open the article in an inline popover.
- Use the data-beacon-article-sidebar attribute to open the article in a sidebar.
- Use the data-beacon-article-modal attribute to open the article in a modal.
<!-- Open Article in Beacon --> <a href="#" data-beacon-article="ARTICLE_ID"></a> <!-- Open Article in a popover --> <a href="#" data-beacon-article-inline="ARTICLE_ID"></a> <!-- Open Article in a sidebar --> <a href="#" data-beacon-article-sidebar="ARTICLE_ID"></a> <!-- Open Article in a modal --> <a href="#" data-beacon-article-modal="ARTICLE_ID"></a>
Grab the HTML reference snippet of your choice, and plug in the Article ID. You can find the Docs article ID in the editor URL for that article.
Add the HTML reference to any button or linked text you want to display your article.
Embedded Articles work great for offering step-by-step guides side-by-side, adding quick clarifications inline, or popping up video tutorials without leaving the page. Login to get started with Embedded Articles.