grapesjs/docs/api.js

// This script uses documentation to generate API Reference files
const path = require('path');
const documentation = require('documentation');
const fs = require('fs');
const docRoot = __dirname;
const srcRoot = path.join(docRoot, '../src/');

const log = (...args) => console.log(...args);

async function generateDocs () {
  log('Start API Reference generation...');

  await Promise.all([
    ['editor/index.js', 'editor.md'],
    ['asset_manager/index.js', 'assets.md'],
    ['asset_manager/model/Asset.js', 'asset.md'],
    ['block_manager/index.js', 'block_manager.md'],
    ['block_manager/model/Block.js', 'block.md'],
    ['commands/index.js', 'commands.md'],
    ['dom_components/index.js', 'components.md'],
    ['dom_components/model/Component.js', 'component.md'],
    ['panels/index.js', 'panels.md'],
    ['style_manager/index.js', 'style_manager.md'],
    ['storage_manager/index.js', 'storage_manager.md'],
    ['device_manager/index.js', 'device_manager.md'],
    ['device_manager/model/Device.js', 'device.md'],
    ['selector_manager/index.js', 'selector_manager.md'],
    ['css_composer/index.js', 'css_composer.md'],
    ['css_composer/model/CssRule.js', 'css_rule.md'],
    ['modal_dialog/index.js', 'modal_dialog.md'],
    ['rich_text_editor/index.js', 'rich_text_editor.md'],
    ['keymaps/index.js', 'keymaps.md'],
    ['undo_manager/index.js', 'undo_manager.md'],
    ['canvas/index.js', 'canvas.md'],
    ['i18n/index.js', 'i18n.md'],
    ['pages/index.js', 'pages.md'],
    ['pages/model/Page.js', 'page.md'],
    ['parser/index.js', 'parser.md'],
  ].map(async (file) =>
    documentation.build([`${srcRoot}/${file[0]}`], { shallow: true })
      .then(cm => documentation.formats.md(cm, /*{ markdownToc: true }*/))
      .then(output => {
        const res = output
          .replace(/\*\*\\\[/g, '**[')
          .replace(/\*\*\(\\\[/g, '**([')
          .replace(/<\\\[/g, '<[')
          .replace(/\| \\\[/g, '| [')
          .replace('**Extends Model**', '');
        fs.writeFileSync(`${docRoot}/api/${file[1]}`, res);
        log('Created', file[1]);
      })
  ));

  log('API Reference generation done!');
};

generateDocs();