Skip to content

Official docs, website, and handbook for PostHog.

License

Notifications You must be signed in to change notification settings

dungle-scrubs/posthog.com

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

posthoglogo

PostHog.com - Website, docs, blog, and handbook

PRs Welcome GitHub contributors Join Slack Community GitHub commit activity GitHub closed pull requests

Support - Roadmap - Open an issue - Style guide

This is the repository for the PostHog website. It contains:

  • All of our written content and visuals including product features, manuals, docs, blogs, case studies, tutorials, and the handbook
  • Features like questions and answers (using Squeak!), job listings (using Ashby), pricing calculator, roadmap, API docs, and more
  • All the components, templates, logic, and styling to make this work, look pretty, and spark joy

Table of contents

Quick start

  1. Pre-installation

    Install Node and Yarn. (If you're on a Mac with Apple Silicon and get an error with -86 in it, you may need to install Rosetta.)

    npm install --global yarn
  2. Start developing

    Clone the repo then navigate into your new site’s directory, install the site dependencies, and start it up.

    cd posthog.com/
    yarn
    yarn start

    Tip: Seeing a discrepancy between local development and staging/production? Preview the production build locally by running gatsby build && gatsby serve

  3. Open the source code and start editing!

    Your site is now running at http://localhost:8001!

    Note: You'll also see a second link: http://localhost:8001/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

See full instructions on developing PostHog.com locally in our manual.

Advanced setup

Docker

It is also possible to use Docker to run posthog.com locally with this command:

docker run -it --rm \
    -w /app -v "$PWD":/app \
    -p 8000-8001:8000-8001 \
    -e INTERNAL_STATUS_PORT=8001 \
    node:14-slim \
    sh -c 'yarn && yarn start'

Debugging errors on start

  1. Pull the latest changes from master
  2. Run gatsby clean && yarn start or delete node_modules and .cache
  3. Check builds are passing in deployment to Vercel

Working on /docs/api?

  1. Create a personal API key in PostHog
  2. export POSTHOG_APP_API_KEY=key
  3. yarn start

Want Ashby job listings or GitHub contributors to load?

You’ll need to set environment variables for these. See (private) instructions for this.

Contributing

We <3 contributions big and small. In priority order (although everything is appreciated) with the most helpful first:

About

Official docs, website, and handbook for PostHog.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 42.7%
  • MDX 41.8%
  • JavaScript 13.2%
  • SCSS 1.7%
  • CSS 0.6%
  • Python 0.0%