Create example docs

docs/custom/examples/ping_pong.js

@@ -0,0 +1,30 @@
+/*
+  A ping pong bot, whenever you send "ping", it replies "pong".
+*/
+
+// import the discord.js module
+const Discord = require('discord.js');
+
+// create an instance of a Discord Client, and call it bot
+const bot = new Discord.Client();
+
+// the token of your bot - https://discordapp.com/developers/applications/me
+const token = 'your bot token here';
+
+// the ready event is vital, it means that your bot will only start reacting to information
+// from Discord _after_ ready is emitted.
+bot.on('ready', () => {
+  console.log('I am ready!');
+});
+
+// create an event listener for messages
+bot.on('message', message => {
+  // if the message is "ping",
+  if (message.content === 'ping') {
+    // send "pong" to the same channel.
+    message.channel.sendMessage('pong');
+  }
+});
+
+// log our bot in
+bot.login(token);

docs/custom/index.js

@@ -1,5 +1,6 @@
 const files = [
   require('./getting_started'),
+  require('./ping_pong'),
 ];
 
 const categories = {};

docs/custom/ping_pong.js

@@ -0,0 +1,10 @@
+const fs = require('fs-extra');
+
+module.exports = {
+  category: 'Examples',
+  name: 'Ping Pong',
+  data:
+`\`\`\`js
+${fs.readFileSync('./docs/custom/examples/ping_pong.js').toString('utf-8')}
+\`\`\``,
+};

src/structures/Message.js

@@ -84,7 +84,8 @@ class Message {
      * @type {Object}
      * @property {Collection<String, User>} mentions.users Mentioned users, maps their ID to the user object.
      * @property {Collection<String, Role>} mentions.roles Mentioned roles, maps their ID to the role object.
-     * @property {Collection<String, GuildChannel>} mentions.channels Mentioned channels, maps their ID to the channel object.
+     * @property {Collection<String, GuildChannel>}
+     * mentions.channels Mentioned channels, maps their ID to the channel object.
      */
     this.mentions = {
       users: new Collection(),