Problem
The README.md file does not currently include installation instructions. This makes it less convenient for users to understand how to add the package to their project.
Proposed Solution
To improve user experience, I propose adding a clear "Installation" section to the README.md. This section should feature a fenced code block demonstrating how to install the package as a dev dependency using npm.
To ensure the command stays current, it should be generated dynamically using doc-gen comments. The generated command should be:
npm install markdown-magic-transform-treefile-extended --save-dev
Alternatives Considered
A static code block could be manually added. However, a doc-gen approach is superior as it automates the inclusion of the correct package name and version, reducing maintenance and preventing errors.
Additional Context
This enhancement will make the package easier to adopt for new users and ensure documentation quality over time.
Problem
The
README.mdfile does not currently include installation instructions. This makes it less convenient for users to understand how to add the package to their project.Proposed Solution
To improve user experience, I propose adding a clear "Installation" section to the
README.md. This section should feature a fenced code block demonstrating how to install the package as a dev dependency using npm.To ensure the command stays current, it should be generated dynamically using
doc-gencomments. The generated command should be:Alternatives Considered
A static code block could be manually added. However, a
doc-genapproach is superior as it automates the inclusion of the correct package name and version, reducing maintenance and preventing errors.Additional Context
This enhancement will make the package easier to adopt for new users and ensure documentation quality over time.