Cryogen Static Site Generator

You can initialize a new Cryogen website using Leiningen, clj-new, or deps-new.

Using Leiningen

Requires Leiningen 2.5.0 or above.

lein new cryogen my-blog

Using clj-new

clojure -Ttools install com.github.seancorfield/clj-new '{:git/tag "v1.2.362"}' :as clj-new
clojure -TClj-new create :template cryogen :name myname/myblog :force true
cd myname/myblog/

Using deps-new

clojure -Ttools install io.github.seancorfield/deps-new '{:git/tag "v0.4.0"}' :as new
clojure -Sdeps '{:deps {io.github.cryogen-project/cryogen {:git/tag "0.6.6" :git/sha "fcb2833"}}}' -Tnew create :template org.cryogenweb/new :name myname/myblog
cd myname/myblog/

To generate the final static HTML files without running a continuous development server, use one of the following commands. The output will be placed in the directory specified by :public-dest in your configuration (default is public).

# Using Leiningen
lein run

# Using tools-deps
clojure -M:build

Cryogen uses the Selmer templating engine.

Layout Structure:

• Base layouts are located in themes/{theme}/html/base.html. This is where you define global assets (CSS/JS), headers, and footers.
• Specific page layouts should be placed in themes/{theme}/html/ and must match the :layout key in the page's metadata.
• Page layouts should use {% extends "/html/base.html" %} and wrap their unique content in a {% block content %} block.

Example tag.html layout:

{% extends "/html/base.html" %}
{% block content %}
<div id="posts-by-tag">
    <h2 id="tag-title">Posts tagged {{name}}</h2>
    <ul>
    {% for post in posts %}
        <li>
            <a href="{{post.uri}}">{{post.title}}</a>
        </li>
    {% endfor %}
    </ul>
</div>
{% endblock %}

To change your site's theme, update the :theme key in content/config.edn to match a folder name in the themes/ directory.

The default template includes three themes. Note that the Nucleus theme is an external asset that may have specific usage requirements (e.g., keeping the footer).

The generated static site is located in the public folder. You can host this folder using any static web server like Nginx or Apache.

Nginx Example

To serve your site at yoursite.com, configure an Nginx server block as follows:

server {
  listen 80 default_server;
  listen [::]:80 default_server ipv6only=on;
  server_name localhost <yoursite.com> <www.yoursite.com>;

  access_log  /var/log/blog_access.log;
  error_log   /var/log/blog_error.log;

  location / {
    alias       /var/blog/;
    error_page  404 = /404.html;
  }
}

Deployment Steps:

1. Copy the contents of your public folder to the server directory (e.g., /var/blog/).
2. Update the server_name in your Nginx config.
3. Place a custom error page at /var/blog/404.html.

Start a web server that watches the content and themes folders for changes and automatically recompiles.

Using Leiningen

lein serve # or lein serve:fast

Using tools-deps

clojure -X:serve # or clojure -X:serve:fast

Note: The *:fast variants perform partial compilation of only the changed page/post to speed up the process.

Static Generation Only

If you only want to generate the static files without starting a server:

lein run
# or
clojure -M:build

Cryogen uses Highlight.js for syntax highlighting.

To add support for more languages, replace the existing themes/{theme}/js/highlight.pack.js with a customized package downloaded from the Highlight.js website. The initialization function hljs.initHighlightingOnLoad() is automatically called within themes/{theme}/html/base.html.

<script>hljs.initHighlightingOnLoad();</script>

To use the Lotus theme in your Cryogen site, follow these steps:

1. Install Sass: Ensure sass is installed on your system.
2. Configure Sass Path: In your content/config.edn file, set the :sass-path key to the location of your Sass installation. If Sass is installed globally, use the string "sass".
3. Enable the Theme: In content/config.edn, change the :theme key to "lotus".
4. Customize Branding:
   • Open base.html and replace the existing GitHub and LinkedIn links with your own profile links.
   • Replace the white lotus logo in base.html with your preferred logo.
   • For additional social media icons, refer to icons.svg.

;; content/config.edn
{:sass-path "sass"
 :theme "lotus"}

By default, Cryogen uses Markdown. To switch to AsciiDoc:

1. Open project.clj in your site directory.
2. In the :dependencies section, replace cryogen-flexmark with cryogen-asciidoc (ensuring version compatibility).

Once switched, the compiler will look for .asc files in the content/asc directory instead of .md files in content/md.