Separate doc files for each module

[hzlmn]

Hi and thanks for great tool.

I was wondering if there is a way to generate separate markdown files for each module?

Like if I have src/main.js, src/utils.js, I want src/main.md and src/utils.md with correct linking if they have intersection.

[tmcw]

We have a ticket for the HTML variation of this #49 - which is very actionable. For Markdown, it's less so, because of a few assumptions the code currently makes:

• Markdown output can output to stdout, which means it is assumed to be a single file. We do that with JSON too, and don't do that with HTML output, since HTML output is multi-file.

[clepore]

So maybe I missed this in my reading, but how would one do this for the html option now that the actionable PR was merged?

[hzlmn]

@tmcw Yeah it cool that markdown output could be exported to stdout, but I am wondering maybe it possible to provide additional option for decoupling .md files as well.

We use github for hosting our docs and it's pretty good to organize them as markdown super readable.
If you need any help, I can look on it. Just wondering if you want it to be added, or it is our of the scope of this project.

Thanks.

[tmcw]

Yep, help here would be much appreciated! If you can cook up a PR, I'd be more than happy to review it.

[rip3rs]

Not sure if I am in the right place.
I was looking into finding a way to get an h1 on every md page that I generate and have all of the class of method or function imports not being shown and crossed on this page. The way I created multiple *.md files was using gulp-documentation.

const gulp = require('gulp');
const docs = require('gulp-documentation');
const flatmap = require('gulp-flatmap');

...

gulp.task('docs-webos', () => {
  return gulp.src('./webOs/src/*.js')
    .pipe(flatmap((stream, file) => {
      console.log(file.path);
      return gulp.src(file.path)
        .pipe(docs('md',{ filename: file.path.split('/').pop().split('.')[0] + '.md' }))
        .pipe(gulp.dest('WebOs.wiki/WebOs'));
    }));
});

gulp.task('buildDocs', ['docs-webos']);

the output would be:

anything within the webOs/src folder will go to the WebOs.wiki/WebOs folder.

WebOs.wiki -
|
|- WebOs
| |
| |- main.md
| |- utils.md
| |- bla.md
|

Like I said, not sure if this is the correct place to post this ^^