Cryogen: a friendly static site generator
cryogenweb.org
cryogenweb.org
You're pitching at (non-technical?) users who want a static site generator, and then assuming they're automatically Clojure developers.
I'm currently on the lookout for a static website generator (new year, new blog). This webpage is very off putting.
The quick start guide -- install lenonwhatever, fine. The start new project? In what? When do I install your thing? Is your thing lenonwhatever?
When you have lein installed, which involves grabbing the script and running it, then you simply run "lein new cryogen my-blog" and that's it. You now have your static site generator ready to go in the folder called "my-blog".
You got to the folder and run "lein ring server" to serve the site locally and watch for any changes you make. It's literally a 3 step process. Not sure what part of it you found off putting specifically.
I suspect you want people to do step 1 of your 3 step guide, then switch to the terminal, then switch back for step 3 of the 3 step guide? I would recommend making that clearer :) I like a guide I go through step by step, here it seems I have to follow nonlinearly.
Once you have leiningen installed and you run the 3 commands shown a browser window will automatically open up showing your site.
The documentation has detailed instructions on how to customize and configure the site from there on.
> lein new cryogen my-blog
is "create a new project" and Leiningen will automatically look up what cryogen is on clojars.org and fetch the appropriate template, so you don't have to explicitly install cryogen. You really just have to install Leiningen and run the commands given in the box. But I also needed to look at the docs of the different parts to understand that, so definitively potential for improvement there.
Also, it would be nice to find out the language immediately, outside of Clojure-space most people probably don't know what Leiningen is or that it has something to do with Clojure.
I kinda like that my markdown files are cross-compatible with any of these various site generators and would say that YAML front matter is something of a de-facto standard?
If avoiding YAML is an opinionated stance aimed at fellow Lispers, then I think that's fair, but I think the messaging should perhaps be more along the lines of 'this is a site generator for Clojure people', not 'this is the easy site generator'.
I don't think that's a bad thing, as a lot of people prefer to use a site generator written in their language of choice.
Of course this could be made a moot point by offering a YAML plugin and a single line in the docs saying '... or you can use YAML syntax if you'd prefer'.
Also w.r.t using Clojure maps, the metadata section of the writing posts [1] docs page could use a full example, otherwise I need to google Clojure map syntax.
And I'll make a note to add a full example of the metadata in the docs.