crystallize

Version, currently master branch1 version
  • master branchlatestMar 21, 2017

github.com/ideasasylum/crystallize

A static site generator, maybe

0 stars
0 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  crystallize:
    github: ideasasylum/crystallize
    branch: master

master is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal
0.21.1
License
MIT
Author
Jamie Lawrence
Target
  • crystallize from src/crystallize.cr

Dependencies

This version declares no dependencies.

README

Crystallize

A static site generator, maybe

Ideally with just enough content compatibility to reproduce the out from my middleman-powered blog — but much quicker. Currently It takes 10-15mins to render ~1600 pages

It'll be pretty opinionated, with the first goal to be able to render my blog before potentially branching out to be more general purpose. I don't much care for some that can render anything if it can't solve my immediate needs. Likewise, it'll never be as overly complex as Hugo — if you enjoy configuring something to that degree just use Hugo.

Tasks and ideas, in no particular order

  • [ ] Serve files
  • [ ] Parse YAML frontmatter
  • [ ] Copy files without processing
  • [ ] Call external tools for processing, e.g. compress images, concat javascript
  • [ ] Render markdown files to disk
  • [ ] Render ERC files to disk
  • [ ] Blog post rendering (i.e., 2017-01-01-my-post.md => /2017/01/01/mypost.html)
  • [ ] Templates and partials
  • [ ] Tags
  • [ ] Basic view helpers (link_to, stylesheet etc)
  • [ ] Render XML files for sitemaps/rss feeds
  • [ ] Livereload
  • [ ] Incremental builds
  • [ ] Upload to s3
  • [ ] Syntax highlighting of markdown
  • [ ] Byte-for-byte translation of my blog (crystallize output == middleman output)

Contributing

  1. Fork it ( https://github.com/ideasasylum/crystallize/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors