Installing NotiDocs

Step 1: Install the Library

NotiDocs is available as an npm package. Ensure you have Node.js installed and run the following command in your terminal:

npm install notidocs

This will install NotiDocs and its dependencies in your project.

Step 2: Create a Configuration File

Create a notidocs.config.js file in your project’s root to specify which files to scan and where to generate the documentation:

module.exports = {
  files: ['**/*.js'], // Scans all JS files
  output: './docs',   // Local output folder (optional)
  notion: {
    apiKey: 'secret_abc123xyz', // Notion API key
    page: 'NotiDocs Workspace'  // Default Notion page
  }
};

Note: Get your Notion API key from Notion Integrations and configure it in Settings.

Step 3: Generate Your Documentation

Once configured, run this command to scan your code and generate the documentation:

npx notidocs generate

NotiDocs will analyze your files, look for supported tags (see Wiki), and send the documentation to the specified Notion page.

Final Notes

That’s it! You now have NotiDocs installed and ready to document your code. If you run into issues, check the Wiki for supported tags or contact us at Support.