aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorArnold Schrijver <aschrijver@users.noreply.github.com>2017-08-08 22:55:15 +0200
committerJoe Hand <joe@joeahand.com>2017-08-08 13:55:15 -0700
commit5be5993e4bdb22ff18f44e2a519177c70cc87a94 (patch)
treee58313210a296e681bf3227e57f31db227c590a0
parentec45304371864a3d36561ddb6d8fa28a55b57082 (diff)
downloaddat-docs-5be5993e4bdb22ff18f44e2a519177c70cc87a94.zip
dat-docs-5be5993e4bdb22ff18f44e2a519177c70cc87a94.tar.gz
aggregate documented projects from config-file, not awesome-dat README (#79)
* config file for doc aggregation * modify package.json, script uses config file * temporary revert change to package.json * moved configuration to README.md * Update README.md * Update package.json
-rw-r--r--README.md28
-rw-r--r--package.json2
2 files changed, 14 insertions, 16 deletions
diff --git a/README.md b/README.md
index 7d62994..e7d6e5a 100644
--- a/README.md
+++ b/README.md
@@ -30,14 +30,6 @@ npm run paper
This documentation uses [minidocs](https://github.com/freeman-lab/minidocs) for layout, [ecosystem-docs](https://github.com/hughsk/ecosystem-docs) to get documentation from other modules, and ideas from [pull-stream-docs](https://github.com/pull-stream/pull-stream-docs) for auto travis deployment.
-### Viewing Docs Locally
-
-1. Clone Repository
-2. `npm install`
-3. `npm run build:local` to build the docs for local viewing
-4. `npm run update` to update external modules
-4. `npm run start` to view the docs in browser
-
### Deployment
This repository uses [netlify](https://www.netlify.com/) for deployment. Deployment will happen automatically.
@@ -52,14 +44,20 @@ It works this way:
* runs `npm run netlify` which updates remote repos and builds.
* deploys `/dist` to the web
-### NPM Commands
+### Viewing Docs Locally
-#### Local Docs Preview:
+1. Clone Repository
+2. `npm install`
+3. `npm run update` to update external modules
+4. `npm run build:local` to build the docs for local viewing
+5. `npm run start` to view the docs in browser
-* `npm update`: update external module readme files
-* `npm run build:local`: build app & css for local viewing
-* `npm start`: start budo server to view locally
+### Ecosystem-docs Modules
-#### Other commands:
+Ecosystem-docs downloads readme files from the following modules to `docs/modules/`. Add another module to the documentation by adding the module below and updating `contents.json`: `"dat-node": "modules/dat-node.md"`. The 📔 makes it easier to parse (see `package.json`).
-* `n
+* 📔 [dat](https://github.com/datproject/dat)
+* 📔 [hyperdrive](https://github.com/mafintosh/hyperdrive)
+* 📔 [hypercore](https://github.com/mafintosh/hypercore)
+* 📔 [dat-node](https://github.com/datproject/dat-node)
+* 📔 [hyperdiscovery](https://github.com/karissa/hyperdiscovery)
diff --git a/package.json b/package.json
index 3b650d4..951bf8b 100644
--- a/package.json
+++ b/package.json
@@ -6,7 +6,7 @@
"scripts": {
"update:token": "npm run update:list && cat repos.txt | ecosystem-docs sync -t ${GH_TOKEN} && cat repos.txt | ecosystem-docs read -t ${GH_TOKEN} | node scripts/build.js",
"update": "npm run update:list && npm run update:build",
- "update:list": "curl -Ssl https://raw.githubusercontent.com/datproject/awesome-dat/master/readme.md | grep '📔' | egrep -o 'github.com/[a-zA-Z0-9_-]+/[a-zA-Z0-9_-]+' | cut -f 2- -d / | uniq > repos.txt",
+ "update:list": "curl -Ssl https://raw.githubusercontent.com/datproject/docs/master/readme.md | grep '📔' | egrep -o 'github.com/[a-zA-Z0-9_-]+/[a-zA-Z0-9_-]+' | cut -f 2- -d / | uniq > repos.txt",
"update:build": "cat repos.txt | ecosystem-docs sync && cat repos.txt | ecosystem-docs read | node scripts/build.js",
"build:local": "npm run build:css && minidocs docs -c docs/contents.json -o dist -l ./node_modules/dat-design/public/img/dat-hexagon.svg -t 'Dat Documentation' -s assets/styles.css --assets assets --pushstate",
"build:deploy": "npm run build:css && minidocs docs -c docs/contents.json -o dist -l ./node_modules/dat-design/public/img/dat-hexagon.svg -t 'Dat Documentation' -s assets/styles.css --assets assets --full-html",