📘 Markdown To Json Utilitary

Markdown to JSON Util is a simple and efficient Node.js utility to convert .md (Markdown) files into structured JSON objects. It recognizes headings and paragraphs, helping developers turn content into structured data for blogs, CMSs, or static site generators.

📦 installation

Install via NPM:

01. npm install markdown-to-json-utilitary

or clone the repository:

01 git clone https://codeberg.org/CodeNest/markdown-to-json-utilitary.git

🥢 usage

Option 1 — In your Node.js project:

const { convertMarkdownFileToJson } = require("markdown-to-json-util");

(async () => {
    // Ensure the first parameter points to the correct folder at the project root
    const result = await convertMarkdownFileToJson("content", "example.md");
    console.log("JSON result:", result);
})();

Option 2 — Use individual functions:

const {
    readMarkdownFile,
    parseMarkdownToJson
} = require("markdown-to-json-util");

(async () => {
    // Ensure the first parameter points to the correct folder at the project root
    const raw = await readMarkdownFile("content", "example.md");
    const structured = parseMarkdownToJson(raw);
    console.log(structured);
})();

✅ Output Structure

{
  "content": [
    { "type": "heading", "level": 1, "text": "Title Here" },
    { "type": "paragraph", "text": "Some text here..." }
  ],
  "titles": [
    { "level": 1, "text": "Title Here" }
  ]
}

💫 features

• Lightweight – No dependencies required
• Accurate parsing – Distinguishes between headings and paragraphs
• Modular – Use one function or the full pipeline
• Async ready – Works great with async/await

🪡 development

To run the project locally:

01. git clone https://codeberg.org/CodeNest/markdown-to-json-utilitary.git
02. cd markdown-to-json-utilitary

🧰 Example Usage File

This project includes a usage example in usage-example.js. It demonstrates how to:

• Import the main function
• Convert a Markdown file into JSON
• Log the structured result

You can use this file as a reference or starting point for integrating the utility into your own projects.

Tip: You can rename file-example.md or create additional .md files to test other Markdown inputs.

📕 updates

See the UPDATE.me file for changelogs and upcoming features.

📜 license

MIT

🧩 creator

@themandalorian