Git Product home page Git Product logo

blorg's Introduction

./img/blorg.png

… a static site generator using Org Mode files as markup.

Work in progress. Protective eyewear required.

Goals

  • To provide a Jekyll-like workflow (edit markup files, have them automatically processed into HTML),
  • using Org Mode as the markup language,
  • using Hiccup for templating, and
  • supporting all of
    • my art- and image-heavy pages and image galleries;
    • my math- and code-heavy software posts;
    • my narrative-heavy South Pole blog posts.

Motivation

Why Org Mode?

I really like writing in Org Mode (a text editing / outlining / To Do-list processing / scheduling / literate programming / … mode for Emacs). The outliner gets out of my way most of the time and lets me move ideas around while they are being formed, and lets me hide the portions that I’m not focusing on at any given time. I can export to a fairly nice looking PDF document in a few keystrokes. I also use the literate programming and LaTeX / math support just about every day.

Why not just Org Mode?

I.e., why a Clojure app? I find the export tools available for Org Mode are not quite powerful (or fast) enough for a large blog. I got pretty far trying to get the export features to suit, but not far enough – generation of a large site took too long, and customization was too unweildy. In general I much prefer developing software in Clojure than in Emacs Lisp (though admittedly I’m less experienced with the latter).

Why not Jekyll?

I used Jekyll for a few years and was somewhat satisfied by it. But it doesn’t support Org Mode, and I am simply not that fond of Ruby and its related ecosystems. Also I have a number of customizations relating to handling images that I’m unlikely to easily get working with Jekyll.

Installing

It’s not on Clojars (yet). Check out the project and run it with lein run. The program parses any Org Mode files in the source directory and publishes them in the destination directory (/tmp/blorg). At the moment the source and destination directories are hardcoded, so you’ll have to change them in the code. (That will obviously change soon.)

Running tests

The parser has a few dozen tests. Run them with lein spec or lein spec -a.

Work Done / To Do

This is a recently-started project and not yet feature-complete. See pending issues, or completed issues.

License

Copyright (c) 2015 John Jacobsen. MIT license.

Disclaimer

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

blorg's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.