Skip to content

imakira/cerulean

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cerulean

Blogging program written in Clojure/ClojureScript.

Features/Peculiarities

  1. First class org-mode support
  2. Use Emacs itself to convert Org files into HTML
  3. Embed Clojure/ClojureScript code in a org mode file (more on here)
  4. Static generated site, single page applicatoin after rehydration on the browser.
  5. [TODO] Optional JavaScript-free

Install & Usage

  • Warning: early stage of development, expect:
    • excessive debug logging
    • not user-friendly error log
    • unhandled (not so) edge case
    • undocumented usage

Using Docker

  • Pull the latest docker image
    docker pull coruscation/cerulean:latest
        
  • Create a directory, say workspace
    mkdir workspace 
    cd workspace
        
  • Init the workspace
    docker run --rm -it --user 1000:100 -v ./:/cerulean/workspace coruscation/cerulean:latest init
        

    It will create a configuration file: config.edn and a demo blog blogs/demo.org. Check the config.edn for available configuration and blogs/demo.org for example usage.

    Documentations are working in progress.

  • Build the workspace
    docker run --rm -it --user 1000:100 -v ./:/cerulean/workspace coruscation/cerulean:latest build
        

    The generated static pages are put in docs directory, readly to be served under static site hosting service, e.g. Github Pags.

  • Watch the workspace
    docker run --rm -it --user 1000:100 -p 8083:3001 -p 9630:9630 -v ./:/cerulean/workspace coruscation/cerulean:latest watch
        

    Open the browser at localhost:8083.

    Then edit the blogs/demo.org to see the result reflect on the web page.

    (Note: this function is not fully supported as of now, refresh the page if necessary)

Example Site

https://coruscation.net/

About

Static blog generator with Clojure / org-mode

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published