4 |
5 | 
6 |
7 | # Introduction
8 |
9 | This project implements a site generator for [my current
10 | website](http://johnj.com/) using [Emacs Org Mode](http://orgmode.org/).
11 |
12 | # Goals
13 |
14 | - To provide a [Jekyll](https://jekyllrb.com/)-like (or better) workflow: edit markup files,
15 | have them automatically processed into HTML...
16 | - using Org Mode as the markup language...
17 | - supporting all of
18 | - my art- and image-heavy pages and image galleries;
19 | - my math- and code-heavy software posts;
20 | - my narrative-heavy South Pole blog posts.
21 |
22 | # Strategy
23 |
24 | In the past I've written a few (incomplete) Org Mode parsers
25 | ([here](https://github.com/eigenhombre/blorg) is a previous attempt), but HTML
26 | is far easier to manipulate in Clojure using Hiccup or Enlive. The current
27 | code relies on one to export Org Mode to HTML first (with a few keystrokes in
28 | Emacs). The program parses the exported HTML, and modifies the parse tree as
29 | needed to create cross links to other posts, etc.
30 |
31 | # Status
32 |
33 | If I were you, I wouldn't use this yet, other than to steal ideas from it,
34 | since I haven't generalized it for multiple sites.
35 |
36 | # Workflow
37 |
38 | - Make edits to Org files in the source directory `site-source-dir`
39 | (or add new `.org` files there).
40 | - To tag a post (for showing the post type in the navigation section of each
41 | page), add an empty section with the relevant tag(s), e.g.:
42 |
43 | ```
44 | * :mytag:othertag:
45 | ```
46 |
47 | - Export changed/added `.org` file(s) to HTML using `\C-c e hh`
48 | (`org-expert-dispatch` to HTML).
49 | - To change the CSS for the site, edit `index.garden`; source will
50 | be interpreted by the `garden` Clojure library and included in
51 | every page.
52 | - Static files that should be copied /verbatim/ into the /top level of the
53 | target site/ are added to `An org-mode-based blogging engine.
To install, add the following dependency to your project or build file:
[organa "0.0.1-SNAPSHOT"]
Functions for interacting with files, paths, and directories in the 4 | file system.
Public variables and functions:
Implementations of the parts of HTML needed by 5 | this blog engine.
4 | Experimental feature for showing artworks. 5 |
4 | Generate a map of configuration values. 5 | 6 | This should eventually be more configurable. 7 |
(date-for-file-by-os path)Get “update” date and time in milliseconds for a file on the file system.
7 |Useful links: https://github.com/juxt/yada/blob/master/src/yada/resources/file_resource.clj http://stackoverflow.com/questions/2723838/
8 | determine-file-creation-date-in-java
(date-for-org-file site-source-dir basename)Find Joda DateTime for an Org post in HTML format, first looking in the Org Mode header, and if not present there, using the filesystem time.
(easter-egg)4 | Generate a (potentially random) "easter egg" to embed as a comment 5 | in blog post HTML. 6 |
(files-in-directory pathstr & {:keys [as], :or {as :file}})4 | Get list of (non-hidden) files in directory. Examples: 5 | 6 | (files-in-directory "/tmp") 7 | (files-in-directory "/tmp" :as :str) 8 | (files-in-directory "/tmp" :as :file) 9 |
(splitext f)
10 | Split non-extension portion of file name from extension.
11 |
12 | (splitext "a") ;;=> '("a" nil)
13 | (splitext "a.b") ;;=> '("a" "b")
14 | (splitext "a.b.c") ;;=> '("a.b" "c")
15 | 4 | Functions for interacting with files, paths, and directories in the 5 | file system. 6 |
(basename f)7 | Get file (not directory) portion of name of `f`, where `f` is a 8 | `File` or path string. 9 |
(dirfile f)10 | Find the directory File that contains File `f`, which must exist. 11 |
(files-in-directory pathstr & {:keys [as], :or {as :file}})12 | Get list of (non-hidden) files in directory. Examples: 13 | 14 | (files-in-directory "/tmp") 15 | (files-in-directory "/tmp" :as :str) 16 | (files-in-directory "/tmp" :as :file) 17 |
(path & args)18 | Create a file or directory path (string) out of `args`. 19 | 20 | (path "/a" "b" "c.txt") 21 | ;;=> 22 | "a/b/c.txt" 23 |
(splitext f)
24 | Split non-extension portion of file name from extension.
25 |
26 | (splitext "a") ;;=> '("a" nil)
27 | (splitext "a.b") ;;=> '("a" "b")
28 | (splitext "a.b.c") ;;=> '("a.b" "c")
29 | (with-tmp-dir dir-file & body)30 | Create temporary file, bind to `dir-file`, and execute `body` in 31 | that context, removing the directory afterwards. 32 |
4 | Functions for implementing galleries of images. 5 |
(inline-gallery gallery-name)6 | This is invoked directly from one of the org files on the blog! 7 | FIXME: sketchy! 8 |
4 | Implementations of the parts of HTML needed by 5 | this blog engine. 6 |
(create-thumbnail! maxh orig-path thumb-path)(create-thumbnail! orig-path thumb-path)4 | image-file-pattern 5 | ;;=> 6 | #"\.PNG|\.JPG|\.JPEG|\.GIF|\.png|\.jpg|\.jpeg|\.gif" 7 |
(make-rss-feeds topic rss-file-name org-files)(make-rss-feeds rss-file-name org-files)Create RSS feeds for blog.
4 |FIXME: reduce arity FIXME: make more configurable
5 |Date: 2008-02-18 24 | ") 25 | (testing "creation date is correct" 26 | (is (.startsWith (str (d/date-for-org-file d "post")) 27 | "2008-02-18")))))))) 28 | -------------------------------------------------------------------------------- /test/organa/fs_test.clj: -------------------------------------------------------------------------------- 1 | (ns organa.fs-test 2 | (:require [clojure.java.shell :as shell] 3 | [clojure.test :refer [are deftest testing is]] 4 | [clojure.java.io :as io] 5 | [organa.fs :as fs] 6 | [clojure.string :as string]) 7 | (:import [java.io File])) 8 | 9 | (deftest with-tmp-dir-test 10 | (testing "It creates a file object" 11 | (is (instance? java.io.File 12 | (fs/with-tmp-dir d 13 | d)))) 14 | (testing "It contains `organa` in the path" 15 | (is (string/includes? (fs/with-tmp-dir d 16 | (:out (shell/sh "pwd" :dir d))) 17 | "organa"))) 18 | (testing "It cleans up after itself" 19 | (let [path (fs/with-tmp-dir d 20 | (string/trim (:out (shell/sh "pwd" :dir d))))] 21 | (is (not 22 | (.exists (io/file path))))))) 23 | 24 | (deftest path-test 25 | (are [args result] 26 | (testing (str args " => " (pr-str result)) 27 | (is (= result (apply fs/path args)))) 28 | 29 | [] "" 30 | nil "" 31 | ["a"] "a" 32 | ["a" "b"] "a/b")) 33 | 34 | (deftest directory-test 35 | (testing "file / directory operations" 36 | (fs/with-tmp-dir d 37 | (testing "in a temporary directory" 38 | (let [test-file (fs/path d "f.txt") 39 | _ (spit test-file "some text") 40 | parent (fs/dirfile (io/file test-file))] 41 | (testing (str "the parent found by `dirfile` " 42 | "has a single child, the test file we made") 43 | (is (= [(io/file test-file)] 44 | (into [] (.listFiles ^File parent)))) 45 | (testing "using `files-in-directory`, result is same" 46 | (is (= [(io/file test-file)] 47 | (fs/files-in-directory (str parent) 48 | :as :file))))) 49 | (testing "`basename` returns original file name" 50 | (is (= "f.txt" 51 | (fs/basename test-file)))) 52 | (testing "`splitext` returns `basename` and extension" 53 | (is (= ["f" "txt"] 54 | (fs/splitext test-file))))))))) 55 | -------------------------------------------------------------------------------- /tests.edn: -------------------------------------------------------------------------------- 1 | {:kaocha/reporter [kaocha.report/doc] 2 | :kaocha/tests [{:kaocha.testable/type :kaocha.type/clojure.test 3 | :kaocha.testable/id :unit 4 | :kaocha/ns-patterns ["-test$"] 5 | :kaocha/source-paths ["src"] 6 | :kaocha/test-paths ["test"]}]} 7 | --------------------------------------------------------------------------------