Move documentation to the right place

This commit is contained in:
Andreas Hocevar
2015-04-02 14:31:38 +02:00
parent b1e35f7fdd
commit 4cce0f4936
2 changed files with 16 additions and 9 deletions
-9
View File
@@ -115,15 +115,6 @@ Called after install to generate an example index. After new examples are added
Called internally by `parse-examples.js` to build the examples from templates.
The `.html` files in the `examples/` 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 comma separated list of URLs.
## `serve.js`
Run a debug server that provides all library sources unminified. Provides a static server for examples and tests. See the `--help` option for more detail.