If you're looking for [DearDesi](http://dear.desi), the DIY blog platform for normal people
you should go to <http://dear.desi>.
@ -7,8 +6,7 @@ you should go to <http://dear.desi>.
Desirae (this repo) is the code that programmers to use to make DearDesi better
for everyone and to make Desirae-compatible blog platforms. (it's blog-ception!)
Desirae (v0.9)
=======
# Desirae (v0.9)
Desirae is a static webpage compiler written in JavaScript.
@ -19,18 +17,17 @@ It can also run entirely from the commandline (with io.js / node.js).
**Features:**
*`JavaScript` - it's so stable it takes 10 years to get new any features.
* Won't break every time you upgrade OS X and reinstall `brew` (*cough* ruby)
* Decent use of `try { ... } catch(e) ...` and `promise.catch()`
* the idea is that it shouldn't blow up at the slightest parse error without telling you which page is to blame (*cough* ruhoh *cough* jekyll)... bless me
* Browser (optional)
* using your front-end templates to build in your front-end? Imagine that!
* io.js (node.js) (optional)
* if you'd prefer to go headless, you can.
* The server is *very* minimal and could easily be implemented in any language (such as ruby or python).
-`JavaScript` - it's so stable it takes 10 years to get new any features.
- Won't break every time you upgrade OS X and reinstall `brew` (_cough_ ruby)
- Decent use of `try { ... } catch(e) ...` and `promise.catch()`
- the idea is that it shouldn't blow up at the slightest parse error without telling you which page is to blame (_cough_ ruhoh _cough_ jekyll)... bless me
- Browser (optional)
- using your front-end templates to build in your front-end? Imagine that!
- io.js (node.js) (optional)
- if you'd prefer to go headless, you can.
- The server is _very_ minimal and could easily be implemented in any language (such as ruby or python).
Installation
============
# Installation
```bash
bower install --save desirae
@ -38,8 +35,7 @@ bower install --save desirae
npm install --save desirae
```
Why
===
# Why
Because I hate ruby.
@ -51,14 +47,13 @@ more (last year I made dozens of gists and 0 blog posts) and I just couldn't get
versions and gems and whatnot... so I gave up and wrote my own (because I needed something
compatible with ruhoh).
Usage Overview
==============
# Usage Overview
### Before we get started
(disclaimers)
**Browser**: The default fs adapter will request the config files from `/api/fs/`.
**Browser**: The default fs adapter will request the config files from `/api/fs/`.
**Node**: Remember that desirae is built browser-first, and optimized to reduce the number of round-trips
(in case someone actually desides to host a Desi service, y'know?), so... the node adapter is built with
@ -70,11 +65,10 @@ It's an artifact of this project being born out of the ashes of my
### Getting Started
First off you need to declare a state object that will be used in every *desirae* action.
First off you need to declare a state object that will be used in every _desirae_ action.
```javascript
var desi = {}
;
var desi = {};
```
After that you'll load any plugins you need.
@ -156,26 +150,24 @@ Desi.registerRenderer(
);
```
And then you'll initialize Desirae with an *environment*.
And then you'll initialize Desirae with an _environment_.
For any config a widget uses, it should also check on post.fooconfig and theme.fooconfig to make sure that they don't override the foogizmo.config.fooconfig
Migrating from Ruhoh
====================
# Migrating from Ruhoh
There are only a few things in Ruhoh that could only be done in ruby or were otherwise difficult to work around.
config.yml
----------
## config.yml
Instead of having special names for some properties (`_root`)
and `use` sub attributes for others (`twitter` theme, posts directory),
@ -117,19 +109,15 @@ widgets [NO CHANGE]
All directories are ignored by default. If you want a directory to be interpreted as a collection of pages you need to specify it in the `collections` hash.
,path:"The page file's path relative to the base of your website."
,relative_path:"The page file's path relative to its name-spaced directory."
,filename:"The page file's filename (path is not included)."
,categories:"The specified categories for this page. If more than one category is set, only the first one is used. If no categories exist, the URL omits this parameter."
,i_month:"Month from the page’s filename without leading zeros."
,i_day:"Day from the page’s filename without leading zeros."
,title:"The title, as a slug."
,slug:"alias of title"
,name:"alias of title"
,collection:"i.e. posts/ or essays/ or whatever/"
year:"Year from the page’s filename",
month:"Month from the page’s filename",
day:"Day from the page’s filename",
path:"The page file's path relative to the base of your website.",
relative_path:"The page file's path relative to its name-spaced directory.",
filename:"The page file's filename (path is not included).",
categories:
"The specified categories for this page. If more than one category is set, only the first one is used. If no categories exist, the URL omits this parameter.",
i_month:"Month from the page’s filename without leading zeros.",
i_day:"Day from the page’s filename without leading zeros.",
