Doraku / DefaultDocumentation

Create a simple markdown documentation from the Visual Studio xml one.
MIT No Attribution
157 stars 26 forks source link

index.md excluded in rebuild even if reset with DefaultDocumentationAssemblyPageName #100

Closed emersonbottero closed 2 years ago

emersonbottero commented 2 years ago

I'm struggling because I'm using vitepress and there is no way to change the index file the be something else.. I do have the option here to rename but then the rebuild excludes index.md even if reset.

Doraku commented 2 years ago

What do you mean by exclude and reset? DefaultDocumentation just create a page for the assembly with index.md as the default name (configurable via DefaultDocumentationAssemblyPageName). I don't know anything about vitepress, a quick search tells me it is a static site generator using markdown so I guess you expect your site to be automatically updated as the documentation is regenerated?

emersonbottero commented 2 years ago

If I set te filename to something else like baseindex and create my own index.md by hand.. when I rebuild the solution the index.md file I created is also deleted.

Doraku commented 2 years ago

ah ok I get it, yeah all *.md files are deleted from the output directory so if you remove types/members you don't end up with old documentation no longer relevant. I guess you could work around this by adding a post build event to copy your own index.md file to the documentation folder from a different one. With the next version you will be able to provide your own IFileNameFactory implementation with a custom clean logic so you could do that also.

emersonbottero commented 2 years ago

Ok. That's a good idea.