xonecas.io
818
Du

dustymarkdown / files

dustymarkdown / README.md

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