Introduction to Markdown-Magic

Markdown-Magic is a powerful tool for enhancing and automating the content of markdown files. It provides a variety of APIs to perform different operations such as inserting content, reading files, and more. Below, you will find a detailed explanation of dozens of useful API methods along with code snippets for better understanding and practical use. Let’s dive into the world of Markdown-Magic and discover its full potential!

API Examples

1. Using Plugins

Markdown-Magic supports various plugins to extend its functionalities. Here’s how you can use a simple plugin:

  const fs = require('fs');
  const markdownMagic = require('markdown-magic');

  // Example plugin that adds a custom text
  function customPlugin(content, options) {
    return 'Custom text';
  }

  const config = {
    transforms: {
      CUSTOM: customPlugin
    }
  };

  markdownMagic('./path/to/markdown.md', config);

2. Reading File Content

Markdown-Magic allows you to read files and insert their content into your markdown:

  const fs = require('fs');
  const markdownMagic = require('markdown-magic');

  // Plugin to read content from a file
  function fileReaderPlugin(content, options) {
    const filePath = options.filePath;
    return fs.readFileSync(filePath, 'utf8');
  }

  const config = {
    transforms: {
      FILE: fileReaderPlugin
    }
  };

  markdownMagic('./path/to/markdown.md', config);

3. Inserting Dynamic Content

You can insert dynamic content using Markdown-Magic APIs. Here’s a basic example:

  const markdownMagic = require('markdown-magic');

  // Plugin to insert dynamic date
  function datePlugin() {
    return `Today's date is ${new Date().toLocaleDateString()}`;
  }

  const config = {
    transforms: {
      DATE: datePlugin
    }
  };

  markdownMagic('./path/to/markdown.md', config);

Practical Application Example

Let’s put it all together with a practical example application that utilizes multiple Markdown-Magic APIs:

  const fs = require('fs');
  const markdownMagic = require('markdown-magic');
  const path = require('path');

  // Custom plugin to read a specific file content
  function includeFilePlugin(content, options) {
    const filePath = path.join(__dirname, options.filePath);
    return fs.readFileSync(filePath, 'utf8');
  }

  // Plugin to include the current date
  function currentDatePlugin() {
    return `Current Date: ${new Date().toLocaleDateString()}`;
  }

  const config = {
    transforms: {
      INCLUDE: includeFilePlugin,
      DATE: currentDatePlugin
    }
  };

  // Running markdown-magic with the config
  markdownMagic('./README.md', config);

In this example, we use two plugins: one to include the content of a specific file and another to insert the current date. You can configure these plugins as you wish, extending the functionality of your markdown files efficiently.

Explore more on Markdown-Magic and enhance your markdown files with ease!

Hash: 4612357e17636d5b8fb104f073eaf7ee4976070fe812d63297509be560857f08