From eca8723506239ca156cafad1db63a024e8513989 Mon Sep 17 00:00:00 2001 From: Danielv123 Date: Thu, 9 Nov 2017 17:09:59 +0100 Subject: [PATCH] Sorted documentation better, "npm run livedocs" to browse the docs --- documentation.yml | 8 ++++++++ package.json | 4 ++-- 2 files changed, 10 insertions(+), 2 deletions(-) create mode 100644 documentation.yml diff --git a/documentation.yml b/documentation.yml new file mode 100644 index 00000000..df2cbf72 --- /dev/null +++ b/documentation.yml @@ -0,0 +1,8 @@ +toc: + - name: Master Server API + - clusterioMaster + - name: Internal modules + description: | + Here are some helper functions for navigation. + - modManager + - getFactorioLocale \ No newline at end of file diff --git a/package.json b/package.json index ca461709..65678714 100644 --- a/package.json +++ b/package.json @@ -8,8 +8,8 @@ "test": "./node_modules/.bin/istanbul cover ./node_modules/mocha/bin/_mocha -- \"./{,!(node_modules)/**/}*.spec.js\" -R spec || echo .", "start": "echo Run node client.js start [instance] to start slaves && node master.js", "cover": "./node_modules/.bin/istanbul cover ./node_modules/mocha/bin/_mocha -- \"./{,!(node_modules)/**/}*.spec.js\" -R spec || echo . && codecov -t f7b38085-36eb-4d72-84e6-64721910171e", - "docs": "documentation build index.js -f html -o docs", - "livedocs": "documentation serve --watch *.js" + "docs": "documentation build index.js --config documentation.yml -f html -o docs", + "livedocs": "documentation serve --watch *.js --config documentation.yml" }, "keywords": [ "factorio"