search

jsdoc2md / dmd

The default output template for jsdoc2md
MIT License
39 stars 49 forks source link

Add note on how to migrate to V2 #34

Closed vvo closed 8 years ago

vvo commented 8 years ago

Hello! Nice move to sync API. I had to dig a bit to understand we had to move from:

    let dmdStream = dmd({
      template: ...,
      helper: ['./scripts/helpers']
    });

    dmdStream.pipe(fs.createWriteStream('file.md')));
    dmdStream.end(JSON.stringify(data));

to:

    const fileContent = dmd(data, {
      template: ...,
      helper: ['./scripts/helpers']
    });

    const filePath = 'file.md';
    fs.writeFile(filePath, fileContent);

Maybe worth adding to the readme. As a general rule, we try to have CHANGELOG.md, nice and simple.

75lb commented 8 years ago

good morning! Yes, i will put some release notes on the repo, thanks!

75lb commented 8 years ago

done, thanks.

vvo commented 8 years ago

Thx, is the https://github.com/jsdoc2md/dmd#synopsis up to date?