esdoc2 / esdoc2-plugins

MIT License
6 stars 5 forks source link

Automatic manual page detection #3

Closed rgsilva closed 6 years ago

rgsilva commented 6 years ago

Hi!

Any chance I can create a manual based on a path only? For example:

        "manual": {
          "index": "./manual/index.md",
          "files": [
            "./manual/foobar/*.md"
          ]
        }

I took a look at the documentation but couldn't find any easy way of doing that. I thought about making a script that would take a look at the manual folder and modify the final esdoc.json, but that would be kinda annoying. I also considered using the ESDoc class itself for that, but that would require loading ESDoc in a JS file, which has been a pita on my setup.

The way I see, there are two solutions for this: either use the class by itself, which is probably the best one, or modify the esdoc2-integrate-manual-plugin to use glob to load the paths (and therefore supporting wildcards).

Any ideas? Thanks!

MattMcFarland commented 6 years ago

Definitely should update it to use glob 👍

rgsilva commented 6 years ago

Closing as it has been merged already. :smile: