Example sources in the examples dir

2015-04-14 10:27:32 -06:00
parent 8fd2e9f79f
commit 89f5e711e6
309 changed files with 21 additions and 16 deletions
@@ -0,0 +1,10 @@
+# Code examples
+
+The `.html` files in this folder are built by applying the templates in the `config/examples/` folder. Examples have [YAML front-matter](http://www.metalsmith.io) headers with the following properties:
+
+* template: The template from the `config/examples/` directory to use for this example
+* title: The title of the example
+* shortdesc: A short description for the example index
+* docs: Documentation of the example. Can be markdown.
+* tags: Tags for the example index
+* resources: Additional js or css resources required by the example. This is a YAML list of URLs.