Convert markdown files from the provided directory into a single JSON file.

Uses the markdown-json npm package to convert the markdown files from a directory into a single JSON file. This is especially useful in the case of a static API where you're updating content in markdown and then generating a JSON that serves as an API.

This action requires only one mandatory input as outlined below.

This is a sample settings JSON file that you could use. Explanation provided below.

{
  "name": "My API",
  "cwd": "./",
  "src": "example/content/",
  "filePattern": "**/*.md",
  "ignore": "*(icon|input)*",  
  "metadata": true,  
  "deterministicOrder": false,
  "dist": "example/output.json",
  "display": false,  
  "server": true,
  "port": 3215,
}

The JSON file will be sent to the directory provided in the dist key of the settings JSON file. Use the actions/upload-artifact to make the JSON file available as an artifact, or commit these files into the repository if that better suits your requirements.

Let's say this is your project structure. You have some markdown files in a folder called markdown that you want to convert and combine into a single JSON file. You also have the settings JSON file in the setting folder which the GitHub action will use.

your project
|
|── .github/workflows/
|  |── convert.yml
|── markdown
|  |── abc.md
|  |── def.md
|── settings
|  |── convert.json

This is how you'll consume this GitHub action.

- name: Convert markdown to json
  uses: ClydeDz/markdown-to-json@1.0.0
  with:
    settings-json-file: settings/convert.json

This is what your settings JSON file will look like assuming the project structure above.

{
  "cwd": "./",
  "src": "markdown/",
  "filePattern": "**/*.md",
  "dist": "example/api.json",
}