ReactDocBuilder

This is a VS Code extension that automatically generates documentation comments for React code.

Features

• Generate Markdown documentation for React components
• Display the documentation in a preview window
• Export the documentation to a Markdown file

Requirements

• Visual Studio Code

Extension Settings

This extension does not add any VS Code settings.

Known Issues

• The documentation generation feature is still under development. It may not be able to generate documentation for all React components correctly.

Release Notes

1.0.0

Initial release of ReactDocBuilder.

Working with Markdown

You can author your README using Visual Studio Code.  Here are some useful editor keyboard shortcuts:

• Split the editor (Cmd+\ on macOS or Ctrl+\ on Windows and Linux)
• Toggle preview (Shift+Cmd+V on macOS or Shift+Ctrl+V on Windows and Linux)
• Press Ctrl+Space (Windows, Linux, macOS) to see a list of Markdown snippets

For more information

• Visual Studio Code's Markdown Support
• Markdown Syntax Reference

How to use

To generate documentation for a React component, follow these steps:

1. Open the React component file.
2. Run the React-documentation.insertReactComment command from the Command Palette (Ctrl/Cmd+Shift+P).
3. A Markdown preview of the documentation for the component will be displayed in a new window.
4. Review the documentation and make any necessary changes.
5. To export the documentation to a Markdown file, click the Export button in the top-right corner of the preview window.

Video Tutorial

Learn how to use ReactDocBuilder with our step-by-step video tutorial:

Enjoy!