Docusaurus web analytics installation

Install the plugin

Required

Docusaurus is a popular static site generator for documentation. You can add PostHog using the official plugin:

Terminal
npm install --save posthog-docusaurus

Configure the plugin

Required

Add the plugin to your docusaurus.config.js:

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

More options

See the Docusaurus integration docs for more configuration options.

3
Send events
Recommended
Start your Docusaurus site and visit a few pages. PostHog will automatically capture pageviews and other events.
Click around and view a couple pages to generate some events. PostHog automatically captures pageviews, clicks, and other interactions for you.
If you'd like, you can also manually capture custom events:
JavaScript
posthog.capture('my_custom_event', { property: 'value' })
4
Next steps
Recommended
After installing PostHog and ensuring autocapture is enabled, head to your web analytics dashboard to see your data. And then check out our getting started guide.
PostHog tip: Web analytics works with anonymous events. This means if you are primarily using PostHog for web analytics, it can be significantly cheaper for you.

Docusaurus web analytics installation

Install the plugin

Configure the plugin

Send events

Next steps

Community questions

Was this page useful?