doc: switch to mdbook

Fixes #569.
SignalK · Dec 5, 2021 · 6beec58 · 6beec58
1 parent ace24a8
commit 6beec58
Show file tree

Hide file tree

Showing 40 changed files with 39 additions and 27 deletions.
diff --git a/.gitignore b/.gitignore
@@ -36,9 +36,10 @@ thumbs.db
 .vscode
 
 #Generated by publishing docs
-gitbook-docs/otherBranches.md
-gitbook-docs/vesselsBranch.md
+mdbook/src/otherBranches.md
+mdbook/src/vesselsBranch.md
 
 #Generated
 src/keyswithmetadata.json
+mdbook/[0-9]*
 dist
diff --git a/.npmignore b/.npmignore
@@ -39,4 +39,4 @@ thumbs.db
 .vscode
 
 #Gitbook source files, original and generated
-gitbook-docs
+mdbook
diff --git a/gitbook-docs/.gitignore b/gitbook-docs/.gitignore
diff --git a/gitbook-docs/.npmignore b/gitbook-docs/.npmignore
diff --git a/gitbook-docs/book.json b/gitbook-docs/book.json
diff --git a/mdbook/.gitignore b/mdbook/.gitignore
@@ -0,0 +1,3 @@
+book
+otherBranches.md
+vesselsBranch.md
diff --git a/mdbook/book.toml b/mdbook/book.toml
@@ -0,0 +1,5 @@
+[book]
+authors = []
+language = "en"
+multilingual = false
+src = "src"
diff --git a/mdbook/docker-compose.yml b/mdbook/docker-compose.yml
@@ -0,0 +1,18 @@
+version: '3'
+
+services:
+  mdbook:
+    container_name: mdbook
+    image: peaceiris/mdbook:v0.4.13
+    stdin_open: true
+    tty: true
+    ports:
+      - 3000:3000
+      - 3001:3001
+    volumes:
+      # - ${PWD}/gitbook-docs:/book
+      - ${PWD}/mdbook:/book
+    command:
+      - serve
+      - --hostname
+      - '0.0.0.0'
diff --git a/gitbook-docs/README.md → mdbook/src/README.md b/gitbook-docs/README.md → mdbook/src/README.md
@@ -1,12 +1,7 @@
 # Introduction
 
 This is the documentation for the [Signal K Specification](https://github.com/signalk/specification) _version_
-version, which is available in the following formats;
-
-* [html](http://signalk.org/specification/_version_/doc/) (this document) _version_
-* [pdf](http://signalk.org/specification/_version_/doc/signalk.pdf)
-* [epub](http://signalk.org/specification/_version_/doc/signalk.epub)
-* [mobi](http://signalk.org/specification/_version_/doc/signalk.mobi)
+version ([permalink](http://signalk.org/specification/_version_/doc/)).
 
 ## What is Signal K?
 

diff --git a/gitbook-docs/SUMMARY.md → mdbook/src/SUMMARY.md b/gitbook-docs/SUMMARY.md → mdbook/src/SUMMARY.md
@@ -1,7 +1,7 @@
 # Signal K Specification
 
 * [Signal K Specification](README.md)
-* Getting Started
+* [Getting Started]()
   * [Using SK](start_using.md)
   * [Developing with SK](start_developing.md)
 * [Data Model]()

diff --git a/gitbook-docs/access_requests.md → mdbook/src/access_requests.md b/gitbook-docs/access_requests.md → mdbook/src/access_requests.md
diff --git a/gitbook-docs/apps_api.md → mdbook/src/apps_api.md b/gitbook-docs/apps_api.md → mdbook/src/apps_api.md
diff --git a/gitbook-docs/changelog.md → mdbook/src/changelog.md b/gitbook-docs/changelog.md → mdbook/src/changelog.md
diff --git a/gitbook-docs/connection.md → mdbook/src/connection.md b/gitbook-docs/connection.md → mdbook/src/connection.md
diff --git a/gitbook-docs/consumer_discovery_process.dia → mdbook/src/consumer_discovery_process.dia b/gitbook-docs/consumer_discovery_process.dia → mdbook/src/consumer_discovery_process.dia
diff --git a/gitbook-docs/consumer_discovery_process.png → mdbook/src/consumer_discovery_process.png b/gitbook-docs/consumer_discovery_process.png → mdbook/src/consumer_discovery_process.png
diff --git a/gitbook-docs/data_model.md → mdbook/src/data_model.md b/gitbook-docs/data_model.md → mdbook/src/data_model.md
diff --git a/gitbook-docs/data_model_metadata.md → mdbook/src/data_model_metadata.md b/gitbook-docs/data_model_metadata.md → mdbook/src/data_model_metadata.md
diff --git a/gitbook-docs/data_model_multiple_values.md → mdbook/src/data_model_multiple_values.md b/gitbook-docs/data_model_multiple_values.md → mdbook/src/data_model_multiple_values.md
diff --git a/gitbook-docs/gateway_and_server.dia → mdbook/src/gateway_and_server.dia b/gitbook-docs/gateway_and_server.dia → mdbook/src/gateway_and_server.dia
diff --git a/gitbook-docs/gateway_and_server.png → mdbook/src/gateway_and_server.png b/gitbook-docs/gateway_and_server.png → mdbook/src/gateway_and_server.png
diff --git a/gitbook-docs/get.md → mdbook/src/get.md b/gitbook-docs/get.md → mdbook/src/get.md
diff --git a/gitbook-docs/how_to_help.md → mdbook/src/how_to_help.md b/gitbook-docs/how_to_help.md → mdbook/src/how_to_help.md
diff --git a/gitbook-docs/keys.md → mdbook/src/keys.md b/gitbook-docs/keys.md → mdbook/src/keys.md
diff --git a/gitbook-docs/notifications.md → mdbook/src/notifications.md b/gitbook-docs/notifications.md → mdbook/src/notifications.md
diff --git a/gitbook-docs/put.md → mdbook/src/put.md b/gitbook-docs/put.md → mdbook/src/put.md
diff --git a/gitbook-docs/request_response.md → mdbook/src/request_response.md b/gitbook-docs/request_response.md → mdbook/src/request_response.md
diff --git a/gitbook-docs/rest_api.md → mdbook/src/rest_api.md b/gitbook-docs/rest_api.md → mdbook/src/rest_api.md
diff --git a/gitbook-docs/security.md → mdbook/src/security.md b/gitbook-docs/security.md → mdbook/src/security.md
diff --git a/gitbook-docs/server_only.dia → mdbook/src/server_only.dia b/gitbook-docs/server_only.dia → mdbook/src/server_only.dia
diff --git a/gitbook-docs/server_only.png → mdbook/src/server_only.png b/gitbook-docs/server_only.png → mdbook/src/server_only.png
diff --git a/gitbook-docs/sources.md → mdbook/src/sources.md b/gitbook-docs/sources.md → mdbook/src/sources.md
diff --git a/gitbook-docs/start_developing.md → mdbook/src/start_developing.md b/gitbook-docs/start_developing.md → mdbook/src/start_developing.md
diff --git a/gitbook-docs/start_using.md → mdbook/src/start_using.md b/gitbook-docs/start_using.md → mdbook/src/start_using.md
diff --git a/gitbook-docs/streaming_api.md → mdbook/src/streaming_api.md b/gitbook-docs/streaming_api.md → mdbook/src/streaming_api.md
diff --git a/gitbook-docs/subscription_protocol.md → mdbook/src/subscription_protocol.md b/gitbook-docs/subscription_protocol.md → mdbook/src/subscription_protocol.md
diff --git a/gitbook-docs/urls_ports.md → mdbook/src/urls_ports.md b/gitbook-docs/urls_ports.md → mdbook/src/urls_ports.md
diff --git a/gitbook-docs/versioning.md → mdbook/src/versioning.md b/gitbook-docs/versioning.md → mdbook/src/versioning.md
diff --git a/package.json b/package.json
@@ -11,15 +11,12 @@
     "schema:version": "cross-var replace-in-file /https:\\\\/\\\\/signalk.org\\\\/specification\\\\/[\\\\w\\\\.]+\\\\/schemas\\\\//g https://signalk.org/specification/$npm_package_version/schemas/ './**/*.j*' --ignore=./package.json,./node_modules/** --isRegex --verbose",
     "schema:publish": "git checkout gh-pages && git checkout master -- schemas && cross-var mkdir $npm_package_version && cross-var git add  $npm_package_version  && cross-var git mv schemas/ $npm_package_version/ && git commit -m \"Schemas from master\" && git push",
     "docs:changelog": "github-changes -f gitbook-docs/changelog.md -o signalk -r specification -a --only-pulls --use-commit-body --data=pulls",
-    "docs:prep": "gitbook install gitbook-docs && cross-var replace-in-file /_version_/g $npm_package_version ./gitbook-docs/* --isRegex --verbose && mdprepare gitbook-docs/*.md",
+    "docs:prep": "cross-var replace-in-file /_version_/g $npm_package_version ./mdbook/src/* --isRegex --verbose && mdprepare mdbook/src/*.md",
     "docs:keys": "node scripts/processSchemaFiles.js",
-    "docs:html": "cross-var gitbook build gitbook-docs $npm_package_version/doc",
-    "docs:pdf": "cross-var gitbook pdf gitbook-docs $npm_package_version/doc/signalk.pdf",
-    "docs:mobi": "cross-var gitbook mobi gitbook-docs $npm_package_version/doc/signalk.mobi",
-    "docs:epub": "cross-var gitbook pdf gitbook-docs $npm_package_version/doc/signalk.epub",
-    "docs:serve": "gitbook serve gitbook-docs",
-    "docs:all": "npm run docs:prep && npm run docs:changelog && npm run docs:keys && npm run docs:html && npm run docs:pdf && npm run docs:mobi && npm run docs:epub",
-    "docs:publish": "npm run docs:all && cross-var git add $npm_package_version && git stash && git checkout gh-pages && git pull && cross-var git checkout stash -- $npm_package_version && git add master && cross-var git commit --allow-empty -m $npm_package_version && git push [email protected]:signalk/specification gh-pages"
+    "docs:html": "cross-var docker-compose -f mdbook/docker-compose.yml run mdbook build -d $npm_package_version/doc",
+    "docs:serve": "docker-compose -f mdbook/docker-compose.yml up",
+    "docs:all": "npm run docs:prep && npm run docs:changelog && npm run docs:keys && npm run docs:html",
+    "docs:publish": "TODO npm run docs:all && cross-var git add $npm_package_version && git stash && git checkout gh-pages && git pull && cross-var git checkout stash -- $npm_package_version && git add master && cross-var git commit --allow-empty -m $npm_package_version && git push [email protected]:signalk/specification gh-pages"
   },
   "repository": {
     "type": "git",
@@ -56,7 +53,6 @@
     "chai": "^1.9.2",
     "cross-var": "1.1.0",
     "fsnip": "^0.9.5",
-    "gitbook-cli": "^2.3.0",
     "github-changes": "^1.0.4",
     "infuse.js": "^2.0.2",
     "markdown-it": "^8.0.0",

diff --git a/scripts/processSchemaFiles.js b/scripts/processSchemaFiles.js
@@ -344,8 +344,8 @@ class Parser {
       })
 
       fs.writeFileSync(path.join(__dirname, '../src/keyswithmetadata.json'), JSON.stringify(keysWithMeta, null, 2))
-      fs.writeFileSync(path.join(__dirname, '../gitbook-docs/vesselsBranch.md'), vesselsDoc)
-      fs.writeFileSync(path.join(__dirname, '../gitbook-docs/otherBranches.md'), othersDoc)
+      fs.writeFileSync(path.join(__dirname, '../mdbook/src/vesselsBranch.md'), vesselsDoc)
+      fs.writeFileSync(path.join(__dirname, '../mdbook/src/otherBranches.md'), othersDoc)
     })
 
     /*
-Original file line number
+Diff line change
@@ Expand Up / @@ -39,4 +39,4 @@ thumbs.db @@
     .vscode
     #Gitbook source files, original and generated
-    gitbook-docs
+    mdbook