Add option to append to existing output files if non-API documentation content exists about gomarkdoc HOT 3 CLOSED

Thanks for the suggestion @jdpedrie! I think this would be a great addition to the tool. Based on what I've seen in other tools I would think a comment marker like this would be reasonable:

<!-- gomarkdoc:embed -->

Then when the documentation gets inserted, that would get replaced with:

<!-- gomarkdoc:embed:start -->

The generated documentation...

<!-- gomarkdoc:embed:end -->

The tool would be designed to work with either the individual comment or the pair, replacing any text in between the start and end markers in variation 2.

Thoughts?

from gomarkdoc.

Hey @princjef, thanks for the reply!

I think your suggestion makes sense in cases where a file which would be modified already exists. For instance, a package with a README.md file should probably specify the embed location. Perhaps that, combined with creating new files when an existing one does not exist, would be a good solution?

In my project (a fairly large monorepo), for instance, we have a number of packages which do not have READMEs.

from gomarkdoc.

This has been released in https://github.com/princjef/gomarkdoc/releases/tag/v0.3.1

Take it for a spin and let me know if you run into any issues or have any additional thoughts!

from gomarkdoc.