Option to not overwrite README.md - or insert into it

[arthurzenika]

Is your feature request related to a problem? Please describe.

When generating my docs using handsdown I want to be able to customize the content in README.md which will be the entry point for mkdocs. When I change it (add some content not autogenerated) I then lose all the content.

Describe the solution you'd like Either :

• having an option to not write README.md
• have some markdown markup that enables handsdown to insert the generated content without overwriting custom content.
• document an easy way to have mkdocs use another file which includes the README.md generated by handsdown

Describe alternatives you've considered

My workaround so far : when README.md is overwritten by handsdown I do a git checkout docs/README.md to restore and commit the rest. But this will be limited when new modules are added to the TOC.

[vemel]

Hello! Thank you for the report.

You can also create HANDSDOWN.md document in your project root. All contents of this file will be included to a generated docs/README.md.

Please let me know if this solution works for you.

[arthurzenika]

Hey, thanks for getting back.

That would be great, but I can't find an option in the --help that enables me to configure the output file, I have a path to the output folder, but not indication of configuring the README.md filename generated. Am I missing something ?