index.js

TLDR

This file is used to compile and generate documentation for a project. It reads the version from the package.json file, compiles Markdown files, and generates an HTML template with the compiled documentation. The compiled template is then written to an output file.

Methods

None

Classes

None

const path = require('path');
const fs = require('fs');

const {version} = JSON.parse(fs.readFileSync('package.json'));
const compileMD = require('./compileMD');
const compileAnimationList = require('./compileAnimationList');

const templatePath = path.join(__dirname, 'template.html');
const template = fs.readFileSync(templatePath, 'utf8');
const outputPath = '../docs';
const outputFile = 'index.html';

const docs = compileMD();
const list = compileAnimationList();

const output = path.join(__dirname, outputPath, outputFile);

const withDocs = template.replace('{{docs}}', docs);
const withListAndDocs = withDocs.replace('{{list}}', list);
const withVersion = withListAndDocs.replace('{{version}}', version);

fs.writeFile(output, withVersion, 'utf8', (err) => {
  if (err) console.error(err);
  console.log('Template compiled succesfully.');
});