make-docs.js

const { readdir, createReadStream, writeFile } = require("fs-extra");
const { createInterface } = require("readline");
const { join, parse } = require("path");
const { exec } = require("child_process");

async function runApiExtractor() {
  return new Promise((resolve, reject) => {
    exec(
      'api-extractor run --local',
      (err, stdout, stderr) => {
        console.log(stdout);
        console.error(stderr);
        if (err) {
          reject(err);
        } else {
          resolve();
        }
      }
    );
  });
}

async function runApiDocumenter() {
  return new Promise((resolve, reject) => {
    exec(
      'api-documenter markdown --input-folder temp --output-folder documentation/src/api',
      (err, stdout, stderr) => {
        console.log(stdout);
        console.error(stderr);
        if (err) {
          reject(err);
        } else {
          resolve();
        }
      }
    );
  });
}

async function main() {
  await runApiExtractor();
  await runApiDocumenter();

  const dir = "./documentation/src/api";
  const docFiles = await readdir(dir);

  for (const docFile of docFiles) {
    try {
      const { name: id, ext } = parse(docFile);
      if (ext !== ".md") {
        continue;
      }

      const docPath = join(dir, docFile);
      const input = createReadStream(docPath);
      const output = [];
      const lines = createInterface({
        input,
        crlfDelay: Infinity
      });

      let title = "";
      lines.on("line", line => {
        let skip = false;
        if (!title) {
          const titleLine = line.match(/## (.*)/);
          if (titleLine) {
            title = titleLine[1];
          }
        }
        const homeLink = line.match(/\[Home\]\(.\/index\.md\) > (.*)/);
        if (homeLink) {
          // Skip the breadcrumb for the toplevel index file.
          if (id !== "filecoin.js") {
            output.push(homeLink[1]);
          }
          skip = true;
        }
        // api-documenter expects \| to escape table
        // column delimiters, but docusaurus uses a markdown processor
        // that doesn't support this. Replace with an escape sequence
        // that renders |.
        if (line.startsWith("|")) {
          line = line.replace(/\\\|/g, "|");
        }
        if (!skip) {
          output.push(line);
        }
      });

      await new Promise(resolve => lines.once("close", resolve));
      input.close();

      const header = [
        "---",
        `id: ${id}`,
        `title: ${title}`,
        `hide_title: true`,
        "---"
      ];

      await writeFile(docPath, header.concat(output).join("\n"));
    } catch (err) {
      console.error(`Could not process ${docFile}: ${err}`);
    }
  }
}

main();