Docusaurus
Key Do’s and Don’ts
✅ Install the JavaScript code below in the Documentation.
✅ Insert the JavaScript in the root index.html page of your documentation webpages.
❌ Do Not install the Reo.Dev tracking code more than once on a single page.
Install JavaScript code in your documentation webpages
Copy the above JavaScript code snippets (provided below)
Go to the root index.html page of documentation webpages
Paste the javascript code snippet before the closing tag in the HTML code of your webpage
In case, there are multiple index.html pages that house child routes, include the code once on each page
Please note:
Do not install the Reo.Dev tracking code more than once on a single page.
Please make sure the correct JavaScript code is copied for Docs pages.
Javascript Code Snippet for Docs
Create a custom js file and place the reo initiation script in it. Make sure to place the newly created file in scripts
or js
folder inside of static
folder
!function(){var e,t,n;e="XXXXXX",t=function(){Reo.init({clientID:"XXXXXX"})},(n=document.createElement("script")).src="https://static.reo.dev/"+e+"/reo.js",n.async=!0,n.onload=t,document.head.appendChild(n)}();
Next, we can leverage the object format in scripts attribute in docusaurus.config.js and include the path to newly created js
module.exports = {
scripts: [
// Object format.
{
src: "/scripts/custom-reo.js", // it references from static folder
},
],
};
Verify successful installation of Javascript on documentation webpages
Open a page on your documenation and right-click anywhere on the page.
In the dropdown menu, select Inspect.

In the elements tab, Use the Ctrl + F or Cmd + F and search for “reo.dev”

If the tracking code appears, verify that the code matches.
FAQs
Error Scenarios
Script initiation
Script initiation has been modified to rely on code initiation only on successful callback post download from CDN. So it will only initiate if successfully downloaded. In case the download fails, the docJS won’t get enabled but this eliminates the likelihood of an error scenario of page breaking.
API failure on token delete
On deletion of all Reo tokens, the most recent event tracking data will likely fail, but subsequent API calls will work fine.
Any inadvertent code failure on JavaScript
This should not be an issue since the code is wrapped in a try-catch block, the console may throw errors, which won’t be visible even on the console since logger would be disabled on the script.
If you need assistance with the implementation, contact your Customer Success Manager via the Slack channel or email us at [email protected]
Last updated
Was this helpful?