Skip to main content

Getting Started with Prodcat

Welcome to Prodcat! This tutorial will guide you through the initial steps of setting up your product documentation website.

1. Installation​

First, install Prodcat globally using npm:

npm install -g prodcat
tip

For a more modern approach that avoids global installations, you can use npx. For example, instead of running prodcat init, you can run npx prodcat init. This ensures you are always using the latest version of Prodcat. See our Installation Guide for more details.

2. Initialize Your Project​

Navigate to your desired project directory and initialize Prodcat:

mkdir my-product-docs
cd my-product-docs
prodcat init

This command sets up a basic Docusaurus project and creates a default prodcat.config.js file.

3. Define Your Products​

Create a products.js file in your project root and define your products. (More details in the next tutorial!)

4. Generate and Serve​

Finally, generate your documentation and start the Docusaurus development server:

prodcat generate
cd website
npm start

You should now see your Prodcat-generated documentation website in your browser!