XanderCodes/Example File.md.txt

## README.md

      
    Raw
  

              README.md
            
          
    How this works

To list your plugin on the site, you need to submit both a json and md file with the following information:
JSON File


name: Your plugins name.
creatorName: Your name.
pluginIconUrl: (optional) An icon URL to be used on the site. If not provided, the icon will be set to the default LDM logo.
repoUrl: A link to your plugin's GitHub repository.
creatorGithubUrl: A link to your GitHub profile.
pluginDesc: A brief description of your plugin. This is shown on the plugin card on the homepage, and will be used to generate a plugin page if you do not provide a .md file.
tags: An array of "tags" that are shown on the plugin card on the homepage. They need a "text" field, such as "Deprecated" or "Open Source", and a "color" field, being one of the Bootstrap badge colour classes.

Markdown File

Supports most of the markdown syntaxing format, although there are some slight nuances - see the example file and compare the results to those on the website.
Need help?

This documentation was written quite hastily - if you have any problems, feel free to send me (AppleManYT) a message through our Discord server.

  
## Example File.md.txt
# Hello World!
![alt text](https://news.xbox.com/en-us/wp-content/uploads/sites/2/2020/11/Image1-1.jpg?w=940&resize=1920%2C1080)
This is *awesome*!
?gist https://gist.github.com/XanderCodes/ba0fc3b538eaba574fadd573c61861c2

```
<note>
    <to>Tove</to>
    <from>Jani</from>
    <heading>Reminder</heading>
    <body>Don't forget me this weekend!</body>
</note>
```

```
{
    "employees":
    [
        {"firstName":"John", "lastName":"Doe"},
        {"firstName":"Anna", "lastName":"Smith"},
        {"firstName":"Peter", "lastName":"Jones"}
    ]
}
```

> Apparently this is a block quote??.
text here

?yt https://www.youtube.com/watch?v=G5WcrqecEbk

# Hello again!

[Test Link](#Hello World!)

## Example Plugin.json
{
    "name": "Example Plugin",
    "creatorName": "AppleManYT",
    "pluginIconUrl": "https://i.kym-cdn.com/entries/icons/original/000/016/248/unturned_zambie.png",
    "repoUrl": "https://gist.github.com/XanderCodes/cbaaf198ff6356cbe8f522e214557544",
    "creatorGithubUrl": "https://github.com/XanderCodes/",
    "pluginDesc": "This is an example plugin that developers can look at to help them intergrate their plugins into this list!",
    "tags": [
        {
            "text": "Open Source",
            "color": "badge-primary"
        },
        {
            "text": "Whatever",
            "color": "badge-info"
        }
    ]
}
	# Hello World!
	![alt text](https://news.xbox.com/en-us/wp-content/uploads/sites/2/2020/11/Image1-1.jpg?w=940&resize=1920%2C1080)
	This is awesome!
	?gist https://gist.github.com/XanderCodes/ba0fc3b538eaba574fadd573c61861c2

	```
	<note>
	<to>Tove</to>
	<from>Jani</from>
	<heading>Reminder</heading>
	<body>Don't forget me this weekend!</body>
	</note>
	```

	```
	{
	"employees":
	[
	{"firstName":"John", "lastName":"Doe"},
	{"firstName":"Anna", "lastName":"Smith"},
	{"firstName":"Peter", "lastName":"Jones"}
	]
	}
	```

	> Apparently this is a block quote??.
	text here

	?yt https://www.youtube.com/watch?v=G5WcrqecEbk

	# Hello again!

	[Test Link](#Hello World!)
	{
	"name": "Example Plugin",
	"creatorName": "AppleManYT",
	"pluginIconUrl": "https://i.kym-cdn.com/entries/icons/original/000/016/248/unturned_zambie.png",
	"repoUrl": "https://gist.github.com/XanderCodes/cbaaf198ff6356cbe8f522e214557544",
	"creatorGithubUrl": "https://github.com/XanderCodes/",
	"pluginDesc": "This is an example plugin that developers can look at to help them intergrate their plugins into this list!",
	"tags": [
	{
	"text": "Open Source",
	"color": "badge-primary"
	},
	{
	"text": "Whatever",
	"color": "badge-info"
	}
	]
	}