Notarius - Documentation generator

Notarius is a Visual Studio Code extension designed to generate comprehensive project documentation using Azure OpenAI’s generative AI. By leveraging your custom reference files, Notarius creates one or more markdown files that document your project effortlessly.

Overview

Notarius uses Azure OpenAI to analyze your project and generate documentation automatically. Simply trigger the command, and the extension reads one or more .template.md files—your guides for the required sections and content—to create detailed .md documentation files.

Features

• Automated Documentation Generation: Generate complete markdown documentation with a single command.
• Template-Based Approach: Use reference files ending with .template.md to outline the sections and content needed.
• Azure OpenAI Integration: Harness the power of generative AI to produce high-quality documentation.
• Seamless VS Code Integration: Easily access documentation generation through the VS Code command palette.

Requirements & Setup

Go to Preferences: Open User Settings (JSON) and add the following configuration:

  "notarius.azureOpenaiKey": "AZURE OPENAI KEY HERE",
  "notarius.azureOpenaiEndpoint": "AZURE OPENAI ENDPOINT",
  "notarius.azureOpenaiDeploymentId": "AZURE OPENAI DEPLOYMENT ID",
  "notarius.azureOpenaiApiVersion": "AZURE OPENAI VERSION",

Usage

1. Prepare Your Templates

Create one or more reference files in your project with the extension .template.md. Each template file should list the sections or content you want included in the final documentation.

2. Generate Documentation

Open the command palette with Ctrl+Shift+P (or Cmd+Shift+P on macOS). Enter and select Notarius: Generate Documentation. The extension will process your .template.md files and generate the corresponding .md files for your project.

3. Review and Customize

Once the markdown files are generated, review them for accuracy. Edit or customize the content as necessary to fit your project's needs.

Enjoy!