Tuesday, August 24, 2021

Markdown autodocs: Automation From External or Remote Files

Why Markdown-autodocs

To make your repo more appealing and useful, you need to provide example code snippets in your README.md. It would be inefficient and time-consuming to manually copy and paste each code snippet in its respective place in your README.

This problem can be solved using Markdown-autodocs: a GitHub Action that automatically generates and updates markdown content (like your README.md) from external or remote files. You will need to add markers in your README.md that will tell markdown-autodocs where to insert the code snippet.



from DZone.com Feed https://ift.tt/3mw4aBt

No comments:

Post a Comment