diff --git a/README.md b/README.md index 6cc0691..84b1577 100644 --- a/README.md +++ b/README.md @@ -110,38 +110,29 @@ Parameters semantics: Security warning: At the moment there is no check against directory traversal attack. So include feature may expose files outside of your wiki content-dir. -## Advertisement -If you like what you see here, I am available for work on open source Clojure projects. - -### Phoning home -Smeagol currently requests the WEFT logo in the page footer from my home site. This is mainly so I can get a feel for how many people are using the product. If you object to this, edit the file - - resources/templates/base.html - -and replace the line - - The Web Engineering Factory & Toolworks Developed by WEFT - -with the line - - The Web Engineering Factory & Toolworks Developed by WEFT - -## License -Copyright © 2014-2015 Simon Brooke. Licensed under the GNU General Public License, -version 2.0 or (at your option) any later version. If you wish to incorporate -parts of Smeagol into another open source project which uses a less restrictive -license, please contact me; I'm open to dual licensing it. - ## Prerequisites You will need [Leiningen](https://github.com/technomancy/leiningen) 2.0 or above installed. You will need [node](https://nodejs.org/en/) and [bower](https://bower.io/) installed. -## Running -To start a web server for the application, run: +## Development +To start a development web server for the application, run: lein bower install - lein ring server + lein repl + +And then, when the repl starts up, + + (start-server) + +## Running + +To build a standalone Smeagol jar file, run: + + lein bower install + lein ring uberjar + +**HOWEVER**, this will not run without [configuration](https://github.com/journeyman-cc/smeagol/blob/develop/resources/public/content/Environment%20Variables.md). Alternatively, if you want to deploy to a servlet container (which I would strongly recommend), the simplest thing is to run: @@ -172,3 +163,25 @@ To build your own Docker image, run: lein docker build This will build a new Docker image locally; you can, obviously, push it to your own Docker repository if you wish. + +## Advertisement +If you like what you see here, I am available for work on open source Clojure projects. + +### Phoning home +Smeagol currently requests the WEFT logo in the page footer from my home site. This is mainly so I can get a feel for how many people are using the product. If you object to this, edit the file + + resources/templates/base.html + +and replace the line + + The Web Engineering Factory & Toolworks Developed by WEFT + +with the line + + The Web Engineering Factory & Toolworks Developed by WEFT + +## License +Copyright © 2014-2020 Simon Brooke. Licensed under the GNU General Public License, +version 2.0 or (at your option) any later version. If you wish to incorporate +parts of Smeagol into another open source project which uses a less restrictive +license, please contact me; I'm open to dual licensing it. diff --git a/project.clj b/project.clj index 91a13a1..b147784 100644 --- a/project.clj +++ b/project.clj @@ -1,4 +1,4 @@ -(defproject smeagol "1.0.2" +(defproject smeagol "1.0.3" :description "A simple Git-backed Wiki inspired by Gollum" :url "https://github.com/simon-brooke/smeagol" :license {:name "GNU General Public License,version 2.0 or (at your option) any later version" @@ -7,7 +7,7 @@ [clj-yaml "0.4.0"] [com.cemerick/url "0.1.1"] [com.fzakaria/slf4j-timbre "0.3.7"] - [com.stuartsierra/component "0.3.2"] + [com.stuartsierra/component "0.4.0"] [com.taoensso/encore "2.92.0"] [com.taoensso/timbre "4.10.0"] [com.taoensso/tower "3.0.2" :exclusions [com.taoensso/encore]] @@ -43,7 +43,7 @@ [io.sarnowski/lein-docker "1.0.0"] [lein-environ "1.0.0"] [lein-marginalia "0.7.1" :exclusions [org.clojure/clojure]] - [lein-ring "0.8.13" :exclusions [org.clojure/clojure]]] + [lein-ring "0.12.5" :exclusions [org.clojure/clojure]]] :bower-dependencies [[simplemde "1.11.2"] ;; [vega-embed "3.0.0-beta.20"] ;; vega-embed currently not loaded from Bower because of @@ -58,13 +58,19 @@ :init smeagol.handler/init :destroy smeagol.handler/destroy} + ;; for the time being, I'm not sure that I want to formally deploy this anywhere, and I certainly don't feel + ;; it's fair to clutter clojars.org with it. + :deploy-repositories [["releases" "file:/tmp"] + ["snapshots" "file:/tmp"]] + :release-tasks [["vcs" "assert-committed"] + ["clean"] + ["codox"] ["change" "version" "leiningen.release/bump-version" "release"] ["vcs" "commit"] - ["vcs" "tag" "v." "--no-sign"] - ["clean"] ["bower" "install"] ["ring" "uberjar"] + ["deploy"] ["docker" "build"] ["docker" "push"] ["change" "version" "leiningen.release/bump-version"] diff --git a/src/smeagol/formatting.clj b/src/smeagol/formatting.clj index 6a874c8..94fd134 100644 --- a/src/smeagol/formatting.clj +++ b/src/smeagol/formatting.clj @@ -49,7 +49,7 @@ [^String html-src] (if html-src (cs/replace html-src #"\[\[[^\[\]]*\]\]" - #(let [text (clojure.string/replace %1 #"[\[\]]" "") + #(let [text (cs/replace %1 #"[\[\]]" "") encoded (url-encode text) ;; I use '\_' to represent '_' in wiki markup, because ;; '_' is meaningful in Markdown. However, this needs to