SnooMD Reddit Flavour Markdown Editor

Table of Contents

• About
• Getting Started
• Usage
• Example

About

SnooMD is a markdown editor for Reddit Bots.

Getting Started

Simply require the package, and use the functions to enhance your text posts.

Installing

Download the single file SnooMD.js and put it in your project.
Require the package and create a new Markdown object.

const {
    Markdown
} = require('SnooMD');
const md = new Markdown();

Usage

How to format your markdown strings:

const MarkdownString =
`Hello There! ${md.apply("Bolded Text!", md.bold)}\n
This will be ${md.superscript("SUPERSCRIPTED!")}\n
Here is a fancy codeblock:\n
${md.apply('console.log(markdown)',md.codeblock)}\n
Here is a named link: ${md.link("https://www.google.com","search")}\n
Here is some fenced text: \n${md.fence("Fenced text here for ya")}`

Logging this string will result in this:

Hello There! __Bolded Text!__ 

This will be ^(SUPERSCRIPTED!)

Here is a fancy codeblock:    

`console.log(markdown)`       

Here is a named link: [search](https://www.google.com)

Here is some fenced text:
```javascript
Fenced text here for ya
```

You can easily create tables by using the table function:

// Tables
const row1 = {
    rating: "5",
    type: "Trade",
    comments: "https://www.reddit.com/r/s/g6j7nix?utm_source=share&utm_medium=web2x&context=3"
}
const row2 = {
    rating: "2",
    type: "Giveaway",
    comments: `https://www.reddit.com/r/s/g6j7nix?utm_source=share&utm_medium=web2x&context=3`
}
const row3 = {
    rating: "1",
    type: "Sale",
    comments: "https://www.reddit.com/r/s/g6j7nix?utm_source=share&utm_medium=web2x&context=3"
}
const t = md.table(["Rating", "Type", "Comments"], [row1,row2,row3])

This will result in text formatted as such:

|Rating|Type|Comments|
|:-:|:-:|:-|
|5|Trade|https://www.reddit.com/r/s/g6j7nix?utm_source=share&utm_medium=web2x&context=3|
|2|Giveaway|https://www.reddit.com/r/s/g6j7nix?utm_source=share&utm_medium=web2x&context=3|
|1|Sale|https://www.reddit.com/r/s/g6j7nix?utm_source=share&utm_medium=web2x&context=3|

See more information about reddit markdown formatting here: https://www.reddit.com/wiki/markdown#wiki_blockquotes

Example

See what you can make with this useful tool!

---

---

🌿Welcome to The Greenhouse

User Directory

Here is a directory of all users who have traded on r/Bwz3rBot along with links to the trade discussion threads.

All users are stored alphabetically. Usernames beginning with special characters can be found within the etc section.

A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z | etc

---

How to use this bot?

Users may submit reviews to this bot command thread.

Commands must be formated with a directive of !rate. The first command argument must be the name of the user to be updated. The second argument must be a rating number between 1 and 5 followed by the word stars. The next arg must be the type of interaction. Was it either (a. sale, b. trade, c. giveaway)? If no type is specified, it defaults to a sale. All arguments following interaction type will be converted to a string, and will go into the comments section of the review. Command MUST contain an interaction type of you wish to include a comment.

!rate u/Bwz3r 5 stars sale We had a great interaction! I'm rating u/Bwz3r 5 stars!

This command will be processed by the bot and will find u/Bwz3r within the database. If the user does not exist within the database, the user will be added to the list of reviewed users and will retain the rating given along with any comments, and a link to the command comment. Any future ratings received by this user will be added to their file and any changes made will be instantly updated in the user directory under their alphabetized page. Users scores will be averaged according to number of reviews / scores rounded down. Stars will be awarded each user according to their calculated average rating. Any questions or errors found while using the bot can be submitted to u/Bwz3r. Thank you for reading!

---

A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z | etc

---

---

A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z | etc

---

SnootyScraper

★★★★☆(average score:4, total reviews:2)

Rating	Type	Comments	Permalink
4	sale	pretty good sale!	/r/Bwz3rBot/comments/jaha01/new_follow_thread/g95r9yj/
5	trade	What a great Trade!	/r/Bwz3rBot/comments/jaha01/new_follow_thread/g95r5wu/

stickRollBot

★★☆☆☆(average score:2, total reviews:2)

Rating	Type	Comments	Permalink
1	sale	horrible sale!	/r/Bwz3rBot/comments/jaha01/new_follow_thread/g95r79a/
4	sale	alright sale!	/r/Bwz3rBot/comments/jaha01/new_follow_thread/g95r8ln/