demistifi README

DEMISTIFI is a helper tool for any developer that doesn't want to explain themselves! I

Features

• Multi-Language Support: DEMISTIFI supports a wide range of programming languages, including but not limited to Python, JavaScript, Java, C/C++, and more. Whether you're working on a web application, mobile app, or desktop software, DEMISTIFI has you covered.

• Automated Documentation Generation: With DEMISTIFI, documenting your code is as simple as running a command or clicking a button. The tool analyzes your source code, extracts relevant information such as function names, parameters, return types, and comments, and generates clear and concise documentation in various formats, including HTML, Markdown, and PDF.

• Customizable Templates: Customize the appearance and layout of your documentation with DEMISTIFI's flexible template system. Choose from a variety of pre-designed templates or create your own to match your project's branding and style guidelines.

• Integration with Version Control Systems: Seamlessly integrate DEMISTIFI into your existing workflow by connecting it to popular version control systems like Git. Automatically generate documentation for each code commit or pull request, ensuring that your documentation stays up-to-date with your codebase.

• Interactive Documentation Browser: Easily navigate through your code documentation using DEMISTIFI's interactive browser. Quickly search for specific functions, classes, or modules, and access detailed information such as function signatures, parameter descriptions, and example usage.

• Cross-Platform Compatibility: DEMISTIFI is compatible with Windows, macOS, and Linux operating systems, ensuring that developers can generate documentation regardless of their preferred development environment.

• Continuous Updates and Support: Benefit from regular updates and dedicated support from the DEMISTIFI team. Stay up-to-date with the latest features, improvements, and bug fixes, and receive prompt assistance whenever you encounter any issues.

Requirements

Before using our extension, make sure to set your OPENAI_API_KEY variable

How To Use

Install extension and run demistifi command. You'll generate documentation for your whole project in markdown!

Known Issues

We are in beta testing and still improving the usability of our extension!

Release Notes

Beta release

Enjoy!