Commits

Armael  committed 7b09f4b

Add some details about the stone's directories structure in the doc

  • Participants
  • Parent commits 02eac72

Comments (0)

Files changed (2)

File doc/pages/index.md

 
 * For a more complete example, this documentation is written thanks to
   *Stone*. You can look at the [sources](contribute.html#h3-Sources).
-* Read the [specifications](specs.html) about the templates and the
-  relevant css properties, and make your own templates and themes.
+* Read the [specifications](specs.html) about the structure of the
+  project, the templates and the relevant css properties, and make
+  your own templates and themes.
 * Feel free to [contribute](contribute.html) !

File doc/pages/specs.md

 ## Specifications
 
+### Project structure
+
+If you look into the directory generated by stone by default, you'll
+have :
+{{
+    ├── config.stone
+    ├── data
+    │   ├── style.css
+    │   └── template.html
+    └── pages
+        └── index.md
+}}
+
+* The `config.stone` file describes the configuration of your
+project. It defines it's name, the pages you want to have in the title
+bar, and other things.
+* The `data` directory contains the static content used to generate
+  the pages :
+
+  + `template.html` : the template used for markdown pages. See below.
+  
+  + `style.css` : The stylesheet. The default one is made by
+    [Theotix](http://theotix.me) (thanks to him).
+* The `pages` directory is where you write the pages with your
+  content. If the extension is `.md` or `.markdown`, they'll be parsed
+  as markdown (see below) and generated using the template. Otherwise
+  they will be just copied without modification.
+  
+After running `stone` and generating the static pages, a new directory
+appears :
+{{
+    └── site
+        ├── index.html
+        └── static
+            └── style.css
+}}
+
+The `site` directory contains the generated content : what you want to
+send online to be served by your web server.
+
 ### Pages syntax
 
 *Stone*'s pages are written in a easy-to-read and easy-to-write