aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--.gitignore4
-rw-r--r--contents.json17
-rw-r--r--dat-data.pngbin0 -> 19900 bytes
l---------index.md1
-rw-r--r--package.json17
-rw-r--r--styles.css4
6 files changed, 41 insertions, 2 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..03dfe09
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,4 @@
+dist
+.DS_Store
+repos.txt
+node_modules
diff --git a/contents.json b/contents.json
new file mode 100644
index 0000000..c67dfeb
--- /dev/null
+++ b/contents.json
@@ -0,0 +1,17 @@
+{
+ "Introduction": {
+ "Welcome to Dat": "README.md",
+ "How Dat works": "how-dat-works.md"
+ },
+ "Ecosystem": {
+ "Overview": "ecosystem.md"
+ },
+ "Specification": {
+ "hyperdrive": "hyperdrive.md",
+ "meta.dat": "meta.dat.md"
+ },
+ "References": {
+ "API": "api.md",
+ "DIY Dat": "diy-dat.md"
+ }
+}
diff --git a/dat-data.png b/dat-data.png
new file mode 100644
index 0000000..c8d647b
--- /dev/null
+++ b/dat-data.png
Binary files differ
diff --git a/index.md b/index.md
deleted file mode 120000
index 42061c0..0000000
--- a/index.md
+++ /dev/null
@@ -1 +0,0 @@
-README.md \ No newline at end of file
diff --git a/package.json b/package.json
index ffa1038..5854510 100644
--- a/package.json
+++ b/package.json
@@ -5,6 +5,8 @@
"main": "index.js",
"scripts": {
"update": "curl -Ssl https://raw.githubusercontent.com/clkao/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",
+ "build": "minidocs . -c contents.json -p -o dist -l dat-data.png -t 'The Dat Project' -s styles.css",
+ "deploy": "gh-pages -d dist",
"paper": "pandoc --variable author=\"Maxwell Ogden, Karissa McKelvey, Mathias Buus\" --variable title=\"Dat - Distributed Dataset Synchronization And Versioning\" --variable date=\"Version 1.0.0, May 2016\" --variable classoption=twocolumn --variable papersize=a4paper -s dat-paper.md -o dat-paper.pdf"
},
"repository": {
@@ -17,5 +19,18 @@
"bugs": {
"url": "https://github.com/datproject/docs/issues"
},
- "homepage": "https://github.com/datproject/docs#readme"
+ "homepage": "https://github.com/datproject/docs#readme",
+ "dependencies": {
+ "gh-pages": "^0.11.0",
+ "minidocs": "^2.0.1"
+ },
+ "devDependencies": {
+ "ecosystem-docs": "^1.1.1"
+ },
+ "browserify": {
+ "transform": [
+ "sheetify/transform",
+ "read-directory/transform"
+ ]
+ }
}
diff --git a/styles.css b/styles.css
new file mode 100644
index 0000000..b529cec
--- /dev/null
+++ b/styles.css
@@ -0,0 +1,4 @@
+.minidocs-logo {
+ max-height: 100px;
+ width: inherit !important;
+}