From de4b32c0229db15e56048ad969c3b24345f90862 Mon Sep 17 00:00:00 2001 From: Tissevert Date: Sun, 13 Dec 2020 18:02:14 +0100 Subject: [PATCH] Move UnitJS-related documentation to README --- README.md | 12 ++++++++++++ doc/Deploying-a-hablo-blog.md | 16 ++-------------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 396eabd..a2dcf07 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,18 @@ Install the result cabal new-install hablo ``` +### Dependencies + +Hablo requires [UnitJS](https://git.marvid.fr/Tissevert/UnitJS) which is handled by [SJW](https://git.marvid.fr/Tissevert/SJW). Make sure you have installed it regularly with `SJW`. If it isn't yet, the following commands should help you: + +```bash +cd /tmp +git clone https://git.marvid.fr/Tissevert/UnitJS.git +cd UnitJS +mkdir -p ~/.sjw +cp -r src/ ~/.sjw/unitJS +``` + ### Using hablo (tutorials) Wanna give it a try ? Start by [generating your blog](https://git.marvid.fr/Tissevert/hablo/wiki/Generating%20your%20blog) diff --git a/doc/Deploying-a-hablo-blog.md b/doc/Deploying-a-hablo-blog.md index 2280f97..3048d75 100644 --- a/doc/Deploying-a-hablo-blog.md +++ b/doc/Deploying-a-hablo-blog.md @@ -1,6 +1,6 @@ # Deployment -Since hablo generates static blogs, deployment is a fairly easy step. The only detail to pay attention to is the handling of dependencies. +Since hablo generates static blogs, deployment is a fairly easy step. The only detail to pay attention to is the handling of JS dependencies. We show here a simple local deployment of your blog assuming you use NGinx but this is fairly easy to transpose to your favourite web server. First let's create an NGinx configuration file for your blog. Let's put the following basic configuration @@ -29,23 +29,11 @@ sudo nginx -s reload Now let's install the dependencies. -## UnitJS - -Hablo requires [UnitJS](https://git.marvid.fr/Tissevert/UnitJS) which is handled by [SJW](https://git.marvid.fr/Tissevert/SJW). Make sure you have installed it regularly with `SJW`. If it isn't yet, the following commands should help you: - -```bash -cd /tmp -git clone https://git.marvid.fr/Tissevert/UnitJS.git -cd UnitJS -mkdir -p ~/.sjw -cp -r src/ ~/.sjw/unitJS -``` - ## Remarkable The markdown is converted to HTML in the client browser with the JS library [remarkable](https://github.com/jonschlinkert/remarkable). -We can simply download it in your `js` directory. +We can simply download it in the `js` subdirectory of your blog hablo created when you first invoked it. ```bash wget 'https://cdnjs.cloudflare.com/ajax/libs/remarkable/1.7.1/remarkable.min.js' -O js/remarkable.min.js