From 295d10358d4d05cc2edb1d3067287420a0d1c7c2 Mon Sep 17 00:00:00 2001 From: Clyde D'Souza Date: Tue, 29 Dec 2020 12:54:52 +1300 Subject: [PATCH 1/5] Bump version --- src/install/task.json | 4 ++-- src/process/task.json | 4 ++-- vss-extension.json | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/install/task.json b/src/install/task.json index 2bb2be8..01a8ec4 100644 --- a/src/install/task.json +++ b/src/install/task.json @@ -9,8 +9,8 @@ "author": "Clyde D'Souza", "version": { "Major": 0, - "Minor": 2, - "Patch": 1 + "Minor": 3, + "Patch": 0 }, "instanceNameFormat": "Install Markdown to API Dependencies", "execution": { diff --git a/src/process/task.json b/src/process/task.json index 7394ca5..01d44e0 100644 --- a/src/process/task.json +++ b/src/process/task.json @@ -9,8 +9,8 @@ "author": "Clyde D'Souza", "version": { "Major": 0, - "Minor": 2, - "Patch": 1 + "Minor": 3, + "Patch": 0 }, "instanceNameFormat": "Execute Markdown to API", "inputs": [ diff --git a/vss-extension.json b/vss-extension.json index e965cf2..a769e69 100644 --- a/vss-extension.json +++ b/vss-extension.json @@ -2,7 +2,7 @@ "manifestVersion": 1, "id": "markdown-to-api", "name": "Markdown to API", - "version": "0.2.1", + "version": "0.3.0", "publisher": "clydedsouza", "galleryFlags": [ "Preview" From cf48106bf6c898abea9d22a83b71e8f606bb84b1 Mon Sep 17 00:00:00 2001 From: Clyde D'Souza Date: Tue, 29 Dec 2020 12:55:51 +1300 Subject: [PATCH 2/5] Update support text, add comments in main js files --- README.md | 2 +- src/install/index.js | 1 + src/process/index.js | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9861555..efa5062 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ The following JSON properties are expected in the config file. Find more information on the usage and different scenarios in [this GitHub repository](https://github.com/ClydeDz/markdown-to-api-examples). ## Support -The easiest way is to [create an issue](https://github.com/ClydeDz/markdown-to-api/issues/new/choose) in the GitHub repository. +The easiest way is to [create an issue](https://github.com/ClydeDz/markdown-to-api/issues/new/choose) on GitHub. ## Credits This extension is developed by [Clyde D'Souza](https://twitter.com/clydedz). diff --git a/src/install/index.js b/src/install/index.js index 9c5a66e..2689df6 100644 --- a/src/install/index.js +++ b/src/install/index.js @@ -12,4 +12,5 @@ function run() { } } +// Starts here run(); \ No newline at end of file diff --git a/src/process/index.js b/src/process/index.js index 32d7437..b268c5d 100644 --- a/src/process/index.js +++ b/src/process/index.js @@ -58,4 +58,5 @@ function run() { } } +// Starts here run(); \ No newline at end of file From 49e1702dbbda4334606af139f6edcdc807775e24 Mon Sep 17 00:00:00 2001 From: Clyde D'Souza Date: Tue, 29 Dec 2020 12:56:50 +1300 Subject: [PATCH 3/5] Make extension public --- vss-extension.json | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/vss-extension.json b/vss-extension.json index a769e69..fc3d39d 100644 --- a/vss-extension.json +++ b/vss-extension.json @@ -4,9 +4,7 @@ "name": "Markdown to API", "version": "0.3.0", "publisher": "clydedsouza", - "galleryFlags": [ - "Preview" - ], + "public": true, "targets": [ { "id": "Microsoft.VisualStudio.Services" From 45d709f6ec2635868f07383da820f6a064ff3599 Mon Sep 17 00:00:00 2001 From: Clyde D'Souza Date: Tue, 29 Dec 2020 13:02:04 +1300 Subject: [PATCH 4/5] Update spelling of frontend --- README.md | 2 +- src/package.json | 2 +- src/process/task.json | 2 +- vss-extension.json | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index efa5062..7b60f0e 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ # Markdown to API -This is an Azure DevOps task that generates JSON files from Markdown files which can then be consumed by your frontend app. Basically, a static API generator. +This is an Azure DevOps task that generates JSON files from Markdown files which can then be consumed by your front-end app. Basically, a static API generator. [![Azure DevOps builds](https://img.shields.io/azure-devops/build/clydedsouza/e3d74bc0-b833-41ea-8ec1-0d74115d662a/33?logo=Azure%20DevOps)](https://clydedsouza.visualstudio.com/Markdown%20to%20API/_build) [![Azure DevOps tests](https://img.shields.io/azure-devops/tests/clydedsouza/Markdown%2520to%2520API/33?logo=Azure%20DevOps)](https://clydedsouza.visualstudio.com/Markdown%20to%20API/_build) diff --git a/src/package.json b/src/package.json index c4a8fc5..dd69644 100644 --- a/src/package.json +++ b/src/package.json @@ -1,7 +1,7 @@ { "name": "markdown-to-api", "version": "1.0.0", - "description": "Generate JSON files from Markdown files which can then be consumed by your frontend app. Basically, a static API generator.", + "description": "Generate JSON files from Markdown files which can then be consumed by your front-end app. Basically, a static API generator.", "main": "index.js", "scripts": { "test": "mocha tests/*.test.js --reporter mocha-junit-reporter --timeout 10000 --exit", diff --git a/src/process/task.json b/src/process/task.json index 01d44e0..5511e07 100644 --- a/src/process/task.json +++ b/src/process/task.json @@ -3,7 +3,7 @@ "id": "5a00c9ee-cdb8-4bdb-a3af-97137d8355ba", "name": "markdown-to-api", "friendlyName": "Markdown to API", - "description": "Generate JSON files from Markdown files which can then be consumed by your frontend app. Basically, a static API generator.", + "description": "Generate JSON files from Markdown files which can then be consumed by your front-end app. Basically, a static API generator.", "helpMarkDown": "[More information](https://github.com/ClydeDz/markdown-to-api#markdown-to-api-1)", "category": "Utility", "author": "Clyde D'Souza", diff --git a/vss-extension.json b/vss-extension.json index fc3d39d..386f9b7 100644 --- a/vss-extension.json +++ b/vss-extension.json @@ -10,7 +10,7 @@ "id": "Microsoft.VisualStudio.Services" } ], - "description": "Generate JSON files from Markdown files which can then be consumed by your frontend app. Basically, a static API generator.", + "description": "Generate JSON files from Markdown files which can then be consumed by your front-end app. Basically, a static API generator.", "categories": [ "Azure Pipelines" ], From aa10cffe8262cff188c88c0bca2152a989c87016 Mon Sep 17 00:00:00 2001 From: Clyde D'Souza Date: Tue, 29 Dec 2020 13:09:40 +1300 Subject: [PATCH 5/5] Update overview readme --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7b60f0e..a969857 100644 --- a/README.md +++ b/README.md @@ -15,19 +15,25 @@ This is an Azure DevOps task that generates JSON files from Markdown files which ![MIT License](https://img.shields.io/static/v1.svg?label=📜%20License&message=MIT&color=informational) ## Tasks -![tasks](https://raw.githubusercontent.com/ClydeDz/markdown-to-api/main/images/markdowntoapitasks.png) The extension consists of the following two tasks. You need to add these tasks in this order. 1. Install Markdown to API Dependencies -2. Markdown to API - +2. Markdown to API + +![tasks](https://raw.githubusercontent.com/ClydeDz/markdown-to-api/main/images/markdowntoapitasks.png) + ### Install Markdown to API Dependencies +Add this task before the `Markdown to API` task so all the required dependencies can be installed and ready for use. No inputs required. + ![tasks](https://raw.githubusercontent.com/ClydeDz/markdown-to-api/main/images/markdowntoapitasks-install.png) -Add this task before the `Markdown to API` task so all the required dependencies can be installed and ready for use. No inputs required. + ### Markdown to API +Add this task to process your Markdown files into JSON files. This task requires one user input - the location of the config file including the name of the file itself. So, in the screenshot below, the JSON config file was located in the `Example1` folder and was named `markdown-to-api.json` hence that's the value that was entered in the field. Remember, you can name the config anything you like, and as long as your config file follows the schema (details below), you should be sweet! + ![tasks](https://raw.githubusercontent.com/ClydeDz/markdown-to-api/main/images/markdowntoapitasks-process.png) -Add this task to process your Markdown files into JSON files. This task requires one user input - the location of the config file including the name of the file itself. So, in the screenshot above, the JSON config file was located in the `Example1` folder and was named `markdown-to-api.json` hence that's the value that was entered in the field. Remember, you can name the config anything you like, and as long as your config file follows the schema (details below), you should be sweet! +You can organise your Markdown files as you like. You can also add FrontMatter to each Markdown file. This task will convert each Markdown file into a JSON file and maintain the same folder structure in the output directory. It will also generate a summary JSON file which will contain the details of all Markdown files in a single JSON file. + #### Schema of the config file The following JSON properties are expected in the config file.