Skip to content

Commit

Permalink
Update overview readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ClydeDz committed Dec 29, 2020
1 parent 45d709f commit aa10cff
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit aa10cff

Please sign in to comment.