A powerful CLI for automatic software project documentation generation, compatible with multiple languages and technologies. Simplify and keep your documentation up-to-date with ease.
Currently, Docuforge generates documentation in formats like Markdown. To further improve its functionality, we should add support for generating an HTML version of the entire system documentation. This will allow users to host their project documentation on the web, providing a more interactive and accessible format.
Proposed Features:
HTML Generation: Generate a set of HTML files (or a single HTML file) that consolidates all the generated documentation from the project.
Interactive Elements: Support for interactive features like expandable sections and hyperlinks between documentation sections.
Customizable Styling: Allow users to customize the appearance of the HTML output by applying CSS styles or themes.
Navigation Menu: Automatically generate a navigation menu or sidebar based on the structure of the documentation.
Implementation:
Add a new flag to the CLI for HTML output.
Example:
docuforge -p <DIR_PROJECT> --output-format html
Benefits:
Enables users to host and share their documentation on websites, making it easier for teams or clients to access it.
Provides a more interactive and user-friendly format for navigating complex project documentation.
Currently, Docuforge generates documentation in formats like Markdown. To further improve its functionality, we should add support for generating an HTML version of the entire system documentation. This will allow users to host their project documentation on the web, providing a more interactive and accessible format.
Proposed Features:
Implementation:
Benefits: