HelpOut

HelpOut copied to clipboard

Hi,

I've used this command:

    Save-MarkdownHelp -Module $ProjectName -OutputPath $DocumentationPath -ErrorAction Stop -WarningVariable +WarningVariablesMarkdown -WarningAction SilentlyContinue -SkipCommandType Alias

And this is what I get

While the docs are perfect I also got some unwanted stuff that somehow got copied over. The primary artefacts folder at the top is mine, but the bottom of it, part of Docs folder, not so much.

@StartAutomating any way to get it go away?

@PrzemyslawKlys these files are mostly there because one of the goals of HelpOut is to help make GitHub pages, and, for this, assets and other files need to be copied into the place in the repo used to publish a page.

There are a few parameters that adjust this:

-IncludeExtension controls what extensions are copied by default -ExcludeFile lets you exclude particular files

Hopefully either of these gets the job done. If it does, please close the issue. If it does not, tell me what parameter changes you'd like.

To be honest @StartAutomating I don't understand why would you insert HelpOut.svg (and assets) into my module docs, why would you create a structure that is not used at all by my module, but is part of "dependencies".

Why would I need to exclude file or include extensions for files that don't exists in my module and were included by your module...

@PrzemyslawKlys that is a little weirder.

Can you point me to the module you're trying to publish / your .helpout.ps1 ?

I'll see if I can't figure out what's going on.

As seen on screenshots it's about PSPublishModule.

Any idea on why it's doing it? I want to start including it in my module builder, but this is sort of wrong :)