Docusaurus

Last updated:

|Edit this page

On this page

To easily track your Docusaurus site, you can install the PostHog plugin. This enables you to autocapture pageviews, clicks, session replays, as well as use the other features of PostHog such as surveys.

Install

Once you have your Docusaurus site set up, install the PostHog plugin:

Terminal
npm install --save posthog-docusaurus

or

Terminal
yarn add posthog-docusaurus

Next, add it to your Docusaurus config with your project API key and instance address, both of which you can find in your project settings.

JavaScript
// docusaurus.config.js
module.exports = {
plugins: [
[
"posthog-docusaurus",
{
apiKey: "<ph_project_api_key>",
appUrl: "https://us.i.posthog.com", // optional, defaults to "https://us.i.posthog.com"
enableInDevelopment: false, // optional
},
],
],
};

Run your site again to see events autocaptured by PostHog.

Note:You can pass additional PostHog config options to the plugin, but they are passed through JSON.stringify(), so functions (such as sanitize_properties) are not supported.

Questions?

Was this page useful?

Next article

Flask

PostHog makes it easy to get data about traffic and usage of your Flask app. Integrating PostHog enables analytics, custom events capture, feature flags, and more. This guide walks you through integrating PostHog into your Flask app using the Python SDK . Installation To start, run pip install posthog to install PostHog’s Python SDK. Then, initialize PostHog where you'd like to use it. For example, here's how to capture an event in a simple route: You can find your project API key and…

Read next article