Skip to content

matannahmani/aidocs

Aidocs - Making AI documentation easier

Aidocs is a TypeScript library designed to simplify the process of creating documentation for projects. With its user-friendly interface and powerful features, Aidocs makes it easy for developers to generate high-quality documentation that are accurate and full of details.

Features

  • Easy integration: Aidocs can be easily integrated into any AI project, regardless of the programming language or framework being used.

  • Automated documentation generation: Aidocs can automatically generate documentation based on developer selected files, saving developers time and effort.

Installation

To install Aidocs, simply run:

npm install aidocs --save-dev

Then, at the root of your project run and configure it according to your preferences.

npm run aidocs --gen --cfg

To build the docs, you can then run

npm run aidocs --gen

Contributing

I welcome contributions from anyone who is interested in improving Aidocs. If you would like to contribute, please see our contribution guidelines for more information.

License

Aidocs is licensed under the Apache 2.0 License.

About

No description, website, or topics provided.

Resources

License

Apache-2.0, Apache-2.0 licenses found

Licenses found

Apache-2.0
LICENSE
Apache-2.0
LICENSE.md

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published