Code Docs

CodeDocs Logo

CodeDocs is a Visual Studio Code extension developed by CodeDocsteam. It offers a seamless way to generate detailed documentation for JavaScript and TypeScript code directly within the editor. Whether you're working on functions, or components, CodeDocs simplifies the documentation process, allowing you to focus more on coding.

Features

Automatic Documentation Generation: Instantly generate markdown documentation for your code segments.
Language Support: Currently supports English (EN) and Romanian (RO) for generated documentation.
Custom Keybindings: Quick documentation generation with customizable shortcuts.

Installation

You can install the CodeDocs extension directly from the Visual Studio Code Marketplace:

Open Visual Studio Code.
Go to the Extensions view by clicking on the square icon on the sidebar or pressing Ctrl+Shift+X (Cmd+Shift+X on macOS).
Search for CodeDocs.
Click on the install button.

Alternatively, you can install it via the Command Palette:

Open the Command Palette with Ctrl+Shift+P (Cmd+Shift+P on macOS).
Type ext install Codedocsteam.codedocs and press enter.

Usage

Once installed, you can generate documentation by:

Selecting the text for which you want to generate documentation.
Pressing Ctrl+Shift+E (Cmd+Shift+E on macOS) or right-clicking and selecting Generate documentation from the context menu.

You can switch the documentation language using the Command Palette commands:

Set documentation Ro for Romanian.
Set documentation En for English.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

To contribute to codedocs:

Fork the Project
Create your Feature Branch (git checkout -b my_branch)
Commit your Changes (git commit -m 'Add some stuff')
Push to the Branch (git push origin my_branch)
Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

codedocs