From 338aa5838678b58add89c92dd8a97029bd597b68 Mon Sep 17 00:00:00 2001 From: Schuyler Cebulskie Date: Tue, 22 Nov 2016 19:50:05 -0500 Subject: [PATCH] Set up new-new custom docs mechanism --- docs/examples/{Ping-pong.js => ping.js} | 0 docs/index.yml | 16 ++++++++++++++++ package.json | 4 ++-- 3 files changed, 18 insertions(+), 2 deletions(-) rename docs/examples/{Ping-pong.js => ping.js} (100%) create mode 100644 docs/index.yml diff --git a/docs/examples/Ping-pong.js b/docs/examples/ping.js similarity index 100% rename from docs/examples/Ping-pong.js rename to docs/examples/ping.js diff --git a/docs/index.yml b/docs/index.yml new file mode 100644 index 000000000..4bf13c7e3 --- /dev/null +++ b/docs/index.yml @@ -0,0 +1,16 @@ +- name: General + files: + - name: Welcome + path: welcome.md + - name: Updating your code + path: updating.md + - name: FAQ + path: faq.md +- name: Examples + files: + - name: Ping + path: ping.js + - name: Avatars + path: avatars.js + - name: Webhook + path: webhook.js diff --git a/package.json b/package.json index c5e4c2d1c..35c08a124 100644 --- a/package.json +++ b/package.json @@ -4,8 +4,8 @@ "description": "A powerful library for interacting with the Discord API", "main": "./src/index", "scripts": { - "test": "eslint src && docgen --source src --custom docs", - "docs": "docgen --source src --custom docs --output docs/docs.json", + "test": "eslint src && docgen --source src --custom docs/index.yml", + "docs": "docgen --source src --custom docs/index.yml --output docs/docs.json", "test-docs": "docgen --source src --custom docs", "lint": "eslint src", "web-dist": "node ./node_modules/parallel-webpack/bin/run.js"