xonecas.io
818
Du

dustymarkdown / files

dustymarkdown / markdown / about.md

2.2 KB
1> This project is the new content manager under [xonecas.com](http://xonecas.com). 
2> It's very minimal and light, developer friendly. The idea 
3> is that you can write the dynamic content in markdown and 
4> use dust to combine static and dynamic. 
5
6This app is only possible thanks to:
7------------------------------------
8
9* HTML5 Boilerplate
10* Dust.js
11* Markdown
12
13### The gist:
14
15So the build.js file grabs the source files you write and 
16compiles them into static assets (@TODO add compression 
17and concatenation). The way it knows what to do with your 
18files is because it expects a specific folder/naming 
19convention.
20
21This app is the example of that convention:
22
23
24      root/
25         build.js                // compiler
26         server.js               // static asset provider
27
28         templates/              // home to your pages/views
29            index.dust           // root of the app
30            pagename.dust        // pagename becomes 
31                                 // http://server/pagename
32
33         markdown/               // where your content goes
34            keyname.md           // you can refer to this in 
35                                 // your template using {keyname}
36            section_keyname.md   // you can refer to several
37                                 // keynames using {#section}
38         htdocs/                 // your static content
39            ...
40            ...                  // organize it how you want it
41                                 // just remember that the .html
42                                 // files are created by build.js
43                                 // so don't edit them by hand
44
45The default htdocs folder is from HTML5 Boilerplate and so is 
46the static file server. One difference is that this app uses 
47Ender for the js library, but you're welcome to change it. 
48There is also a very simple unique visitors/request counter.
49
50See the example page [here](/about).
51
52Dependencies
53------------
54
55* `npm install connect dust node-markdown`
56
57More docs:
58----------
59
60* [*HTML5 Boilerplate*  →](http://h5bp.com/)
61* [*Dust*  →](http://akdubya.github.com/dustjs/)
62* [*Markdown*  →](http://daringfireball.net/projects/markdown/basics)