-// 
-// 
-
-const rootDir = dirname(dirname(__dirname));
+const rootDir = dirname(__dirname);
function markdownToHtml(md) {
const renderer = new marked.Renderer();
diff --git a/Tools/git-hooks/pre-commit-sh b/Tools/git-hooks/pre-commit-sh
new file mode 100644
index 0000000000..c63796f6b4
--- /dev/null
+++ b/Tools/git-hooks/pre-commit-sh
@@ -0,0 +1,14 @@
+#!/bin/sh
+
+# In pre-commit, PWD is set to the root of the repo
+# https://longair.net/blog/2011/04/09/missing-git-hooks-documentation/
+ROOT_DIR="$PWD"
+
+# If any README file has been changed, update the website
+'README\|build-website'
+git status -s | grep ' README\| build-website.js' > /dev/null
+readmeStatus=$?
+if [ $readmeStatus -eq 0 ]; then
+ node "$ROOT_DIR/Tools/build-website.js"
+ git add docs
+fi
\ No newline at end of file
diff --git a/Tools/package-lock.json b/Tools/package-lock.json
index b3de2bd3f9..b478b4309a 100644
--- a/Tools/package-lock.json
+++ b/Tools/package-lock.json
@@ -4,6 +4,14 @@
"lockfileVersion": 1,
"requires": true,
"dependencies": {
+ "encoding": {
+ "version": "0.1.12",
+ "resolved": "https://registry.npmjs.org/encoding/-/encoding-0.1.12.tgz",
+ "integrity": "sha1-U4tm8+5izRq1HsMjgp0flIDHS+s=",
+ "requires": {
+ "iconv-lite": "0.4.19"
+ }
+ },
"fs-extra": {
"version": "4.0.2",
"resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-4.0.2.tgz",
@@ -14,11 +22,25 @@
"universalify": "0.1.1"
}
},
+ "gettext-parser": {
+ "version": "1.3.0",
+ "resolved": "https://registry.npmjs.org/gettext-parser/-/gettext-parser-1.3.0.tgz",
+ "integrity": "sha512-iloxjcw+uTPnQ8DrGICWtqkHNgk3mAiDI77pLmXQCnhM+BxFQXstzTA4zj3EpIYMysRQnnNzHyHzBUEazz80Sw==",
+ "requires": {
+ "encoding": "0.1.12",
+ "safe-buffer": "5.1.1"
+ }
+ },
"graceful-fs": {
"version": "4.1.11",
"resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.1.11.tgz",
"integrity": "sha1-Dovf5NHduIVNZOBOp8AOKgJuVlg="
},
+ "iconv-lite": {
+ "version": "0.4.19",
+ "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.19.tgz",
+ "integrity": "sha512-oTZqweIP51xaGPI4uPa56/Pri/480R+mo7SeU+YETByQNhDG55ycFyNLIgta9vXhILrxXDmF7ZGhqZIcuN0gJQ=="
+ },
"jsonfile": {
"version": "4.0.0",
"resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz",
@@ -27,6 +49,21 @@
"graceful-fs": "4.1.11"
}
},
+ "marked": {
+ "version": "0.3.7",
+ "resolved": "https://registry.npmjs.org/marked/-/marked-0.3.7.tgz",
+ "integrity": "sha512-zBEP4qO1YQp5aXHt8S5wTiOv9i2X74V/LQL0zhUNvVaklt6Ywa6lChxIvS+ibYlCGgADwKwZFhjC3+XfpsvQvQ=="
+ },
+ "mustache": {
+ "version": "2.3.0",
+ "resolved": "https://registry.npmjs.org/mustache/-/mustache-2.3.0.tgz",
+ "integrity": "sha1-QCj3d4sXcIpImTCm5SrDvKDaQdA="
+ },
+ "safe-buffer": {
+ "version": "5.1.1",
+ "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.1.tgz",
+ "integrity": "sha512-kKvNJn6Mm93gAczWVJg7wH+wGYWNrDHdWvpUmHyEsgCtIwwo3bqPtV4tR5tuPaUhTOo/kvhVwd8XwwOllGYkbg=="
+ },
"universalify": {
"version": "0.1.1",
"resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.1.tgz",
diff --git a/Tools/package.json b/Tools/package.json
index 235a614f07..73ba24530f 100644
--- a/Tools/package.json
+++ b/Tools/package.json
@@ -9,6 +9,9 @@
"author": "",
"license": "ISC",
"dependencies": {
- "fs-extra": "^4.0.2"
+ "fs-extra": "^4.0.2",
+ "gettext-parser": "^1.3.0",
+ "marked": "^0.3.7",
+ "mustache": "^2.3.0"
}
}
diff --git a/docs/desktop/index.html b/docs/desktop/index.html
index 3a9cecb033..1357b34b42 100644
--- a/docs/desktop/index.html
+++ b/docs/desktop/index.html
@@ -193,7 +193,7 @@
diff --git a/docs/index.html b/docs/index.html
index 6ddcaaf3ab..92e0a1bdae 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -193,7 +193,7 @@
@@ -250,10 +250,10 @@
IMPORTANT: Node v8+ is required
On macOS:
-brew install joplin
-On Linux or Windows (via WSL), type:
+brew install node joplin
+On Linux or Windows (via WSL):
+Important: First, install Node 8+. Node 8 is LTS but not yet available everywhere so you might need to manually install it.
NPM_CONFIG_PREFIX=~/.joplin-bin npm install -g joplin
sudo ln -s ~/.joplin-bin/bin/joplin /usr/bin/joplin
By default, the application binary will be installed under ~/.joplin-bin. You may change this directory if needed. Alternatively, if your npm permissions are setup as described here (Option 2) then simply running npm -g install joplin would work.
The notes can be synchronised with various targets including the file system (for example with a network directory) or with Microsoft OneDrive. When synchronising the notes, notebooks, tags and other metadata are saved to plain text files which can be easily inspected, backed up and moved around.
IMPORTANT: Node v8+ is required
On macOS:
-brew install joplin
-On Linux or Windows (via WSL), type:
+brew install node joplin
+On Linux or Windows (via WSL):
+Important: First, install Node 8+. Node 8 is LTS but not yet available everywhere so you might need to manually install it.
NPM_CONFIG_PREFIX=~/.joplin-bin npm install -g joplin
sudo ln -s ~/.joplin-bin/bin/joplin /usr/bin/joplin
By default, the application binary will be installed under ~/.joplin-bin. You may change this directory if needed. Alternatively, if your npm permissions are setup as described here (Option 2) then simply running npm -g install joplin would work.