Step-by-Step Guide: Integrating NotiDocs with Notion

Introduction

NotiDocs is a powerful tool that automates documentation generation and integrates directly with Notion. In this article, I’ll guide you step-by-step to set up this integration and make the most of its capabilities.

Step 1: Get Your Notion API Key

To get started, you’ll need a Notion API key. Head to Notion Integrations, create a new integration, and copy the secret key starting with secret_.

Step 2: Configure NotiDocs

Once you have the key, go to the Settings page in NotiDocs and enter your API key along with the default Notion page where you want the documentation to be generated (e.g., "NotiDocs Workspace").

module.exports = {
  files: ['**/*.js'],
  output: './docs',
  notion: { apiKey: 'secret_abc123xyz', page: 'NotiDocs Workspace' }
};
    

Step 3: Generate Your Documentation

Run the following command in your terminal to scan your code and send the documentation to Notion:

npx notidocs generate
    

And that’s it! You’ll find your documentation organized as subpages in the specified Notion page.

Conclusion

Integrating NotiDocs with Notion is a straightforward process that can save you hours of manual work. Try this setup and start enjoying automated, professional documentation today.