From 638e027cf36fc86c1505cfd88434a9b89d750994 Mon Sep 17 00:00:00 2001 From: Matt Baer Date: Fri, 2 Feb 2024 16:40:05 +0100 Subject: [PATCH 1/3] Remove go-bindata mention from dev setup docs No longer needed as of writefreely/writefreely#610 (v0.14) --- developer/setup.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/developer/setup.md b/developer/setup.md index f4cb161..b55d88c 100644 --- a/developer/setup.md +++ b/developer/setup.md @@ -30,14 +30,6 @@ git clone https://github.com/writefreely/writefreely.git cd writefreely ``` -Next, install the bindata generator and create `bindata.go` (needed for a successful build). - -```bash -GOPATH=${GOPATH:-$HOME/go/bin} -go install github.com/jteeuwen/go-bindata/go-bindata -${GOPATH}/go-bindata -pkg writefreely -ignore=\\.gitignore schema.sql sqlite.sql -``` - Finally, build the `writefreely` binary with SQLite support. (Remove `-tags='sqlite'` if you don't need SQLite support.) ```bash From d9aa351b5df5b1b9303d5ca375daa39d5c24b6cc Mon Sep 17 00:00:00 2001 From: Matt Baer Date: Fri, 2 Feb 2024 16:50:48 +0100 Subject: [PATCH 2/3] Update Go version required and add Node version in dev setup --- developer/setup.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/developer/setup.md b/developer/setup.md index b55d88c..195235c 100644 --- a/developer/setup.md +++ b/developer/setup.md @@ -4,8 +4,8 @@ Ready to hack on your site? Here's a quick overview. ## Prerequisites -* [Go 1.13+](https://golang.org/dl/) -* [Node.js](https://nodejs.org/en/download/) +* [Go 1.19+](https://golang.org/dl/) +* [Node.js 15+](https://nodejs.org/en/download/) ## Quick start From 49e944bce6232fbe843b5785f9ee66344d08f711 Mon Sep 17 00:00:00 2001 From: Matt Baer Date: Fri, 2 Feb 2024 17:07:34 +0100 Subject: [PATCH 3/3] Update site asset setup instructions --- developer/setup.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/developer/setup.md b/developer/setup.md index 195235c..eec676a 100644 --- a/developer/setup.md +++ b/developer/setup.md @@ -40,21 +40,29 @@ You can now run WriteFreely! But you'll need one more step to generate some asse ### Building site assets -You'll need Node.js and LESS installed to generate WriteFreely static assets. Install LESS: +You'll need Node.js and LESS installed to generate WriteFreely static assets. Install LESS using our utility script: ```bash -npm install less less-plugin-clean-css +./less/install-less.sh ``` Next, compile all stylesheets from the `less` directory, creating them in the `static/css/` directory: ```bash cd less -LESSC=../node_modules/less/bin/lessc CSSDIR=../static/css -$LESSC app.less --clean-css="--s1 --advanced" ${CSSDIR}/write.css -$LESSC fonts.less --clean-css="--s1 --advanced" ${CSSDIR}/fonts.css -$LESSC icons.less --clean-css="--s1 --advanced" ${CSSDIR}/icons.css +lessc app.less --clean-css="--s1 --advanced" ${CSSDIR}/write.css +lessc fonts.less --clean-css="--s1 --advanced" ${CSSDIR}/fonts.css +lessc icons.less --clean-css="--s1 --advanced" ${CSSDIR}/icons.css +lessc prose.less --clean-css="--s1 --advanced" ${CSSDIR}/prose.css +``` + +Finally, build ProseMirror: + +```bash +cd ../prose +npm install +npm run-script build ``` Now you can run and distribute WriteFreely! 🎉