Как конвертировать JSON на Markdown с помощью JSON2MD

Автор оригинала: Johnny B. (Ionică Bizău).

Я люблю и использовать как json, так и Реклама в моих проектах. Каждый NPM Пакет требует Package.json Файл, который, очевидно, написано в формате JSON. Также хорошие проекты имеют хорошую документацию. Мой любимый язык для написания документов – Markdown.

Но я не очень пишу файлы Markdown. Я пишу документы, но они хранятся в коде (комментарии JSDOC). Я автоматизировал процесс Создание документов Markdown с использованием BLAH Отказ Однако иногда эти шаблоны документации недостаточно.

Вот почему я создал json2md который является мостом между языками JSON и Markdown. Интеграция этого пакета с моими шаблонами BLAH, я могу записать пользовательские вещи в результате окончательной документации, используя входы JSON в My Package.json (или другой файл json).

Как использовать

Все начинается с NPM I JSON2MD Для загрузки и установки json2md Пакет локально. Тогда вы можете требуется Это в вашем Node.js приложений или даже на стороне клиента (в браузере).

Например, чтобы создать результат изображения Markdown, вы должны сделать это:

var json2md = require("json2md");

var myImg = json2md({
    img: {
        source: "http://example.com/image.png"
      , title: "My image"
    }
});
console.log(myImg);

Это будет выводить ! [Мой образ] (http://example.com/image.png) Отказ

Вот еще один пример, который является более сложным:

// Dependencies
var json2md = require("json2md");

console.log(json2md([
    { h1: "JSON To Markdown" }
  , { blockquote: "A JSON to Markdown converter." }
  , { img: [
        { title: "Some image", source: "https://example.com/some-image.png" }
      , { title: "Another image", source: "https://example.com/some-image1.png" }
      , { title: "Yet another image", source: "https://example.com/some-image2.png" }
      ]
    }
  , { h2: "Features" }
  , { ul: [
        "Easy to use"
      , "You can programatically generate Markdown content"
      , "..."
      ]
    }
  , { h2: "How to contribute" }
  , { ol: [
        "Fork the project"
      , "Create your branch"
      , "Raise a pull request"
      ]
    }
]));

Это будет генерировать:

# JSON To Markdown
> A JSON to Markdown converter.

![Some image](https://example.com/some-image.png)

![Another image](https://example.com/some-image1.png)

![Yet another image](https://example.com/some-image2.png)

## Features

 - Easy to use
 - You can programatically generate Markdown content
 - ...

## How to contribute

 1. Fork the project
 2. Create your branch
 3. Raise a pull request

И это не все! Вы можете создать свои пользовательские преобразователи. Давайте предположим, что у вас есть вход, как {Sayheello: «Мир»} Отказ Если вы хотите создать Привет мир! Вывод, вы можете сделать:

json2md.converters.sayHello = function (input) {
     return "Hello " + input "!";
};

Это в основном расширяет Конвертеры Объект и добавляет ваш пользовательский конвертер.

Проверьте json2md на Github Отказ Я уверен, что есть много вещей, чтобы улучшить. Не стесняйтесь задавать вопросы, открытые проблемы и вклад!