Coralite Library

const coralite = new Coralite({
  templates: './src/templates',
  pages: './src/pages',
  plugins: [myCustomPlugin],
  ignoreByAttribute: [
    { name: 'data-ignore', value: 'true' },
    { name: 'aria-hidden', value: 'true' }
  ]
});

/**
 * Initialises the Coralite instance.
 * @returns {Promise

/**
 * Compiles specified page(s) by rendering their document content and measuring render time.
 * Processes pages based on provided path(s), replacing custom elements with components,
 * and returns rendered results with performance metrics.
 *
 * @param {string | string[]} [path] - Path to a single page or array of page paths relative to the pages directory. If omitted, compiles all pages.
 * @return {Promise

coralite.compile('pages/home/index.html')
  .then(documents => {
    console.log('Compilation result:', documents);
  })
  .catch(error => {
    console.error('Error during compilation:', error);
  });

coralite.compile(['pages/home/index.html', 'pages/about/index.html'])
  .then(documents => {
    documents.forEach((document, index) => {
      console.log(`Result for page ${index + 1}:`, document);
    });
  })
  .catch(error => {
    console.error('Error during compilation:', error);
  });

coralite.compile()
  .then(documents => {
    console.log('All compiled documents:', documents)
  })
  .catch(error => {
    console.error('Error compiling all pages:', error)
  });

/**
 * Saves processed documents as HTML files to the specified output directory.
 * @param {Array

coralite.compile()
  .then(async (documents) => {
    // save documents to disk
    await coralite.save(documents, './output')
  })
  .catch(error => {
    console.error('Error compiling all pages:', error)
  })

/**
 * Renders the provided node or array of nodes using the render function.
 * This method serves as an internal utility to handle the rendering process.
 * @private
 * @param {CoraliteDocumentRoot | CoraliteAnyNode | CoraliteAnyNode[]} root - The node(s) to be rendered.
 * @returns {string} returns raw HTML
 */
coralite._render(root)

/**
 * Retrieves page paths associated with a custom element template.
 *
 * @param {string} path - The original path potentially prefixed with the templates directory.
 * @returns {string[]} An array of page paths linked to the custom element template.
 */
coralite.getPagePathsUsingCustomElement(path)

/**
 * Adds a page to the current render queue.
 * @param {string|CoraliteCollectionItem} value - The path to a page or a CoraliteCollectionItem to add to the render queue.
 */
coralite.addRenderQueue(value)

/**
 * @param {Object} options
 * @param {string} options.id - id - Unique identifier for the component
 * @param {CoraliteModuleValues} [options.values={}] - Token values available for replacement
 * @param {CoraliteElement} [options.element] - Mapping of component IDs to their module definitions
 * @param {CoraliteDocument} options.document - Current document being processed
 * @param {string} [options.contextId] - Context Id
 * @param {number} [options.index] - Context index
 * @param {boolean} [head=true] - Indicates if the current function call is for the head of the recursion
 * @returns {Promise