Add support for examples #14

examples/docs/README.md

@@ -11,6 +11,7 @@
 * [Custom](./deepextending.schema.md) – `https://example.com/schemas/deepextending`
 * [Definitions](./definitions.schema.md) – `https://example.com/schemas/definitions`
 * [Example](./example.schema.md) – `https://example.com/schemas/example`
+* [Examples](./examples.schema.md) – `https://example.com/schemas/examples`
 * [Extending](./extending.schema.md) – `https://example.com/schemas/extending`
 * [Extensible](./extensible.schema.md) – `https://example.com/schemas/extensible`
 * [Simple](./simple.schema.md) – `https://example.com/schemas/simple`

examples/docs/example.schema.md

@@ -15,4 +15,9 @@ This is an example schema with examples. Too many examples? There can never be t
 |----------|------------|-------------------|------------|
 | Can be instantiated | No | Forbidden | [example.schema.json](example.schema.json) |
 
+## Example Example
+```json
+{"foo":"bar","bar":"baz"}
+```
+
 ---
\ No newline at end of file

examples/docs/examples.schema.md

+---
+template: reference
+foo: bar
+---
+
+# Examples Schema
+
+```
+https://example.com/schemas/examples
+```
+
+This is an example schema with *multiple* examples. Too many examples? There can never be too many examples!
+
+| Abstract | Extensible | Custom Properties | Defined In |
+|----------|------------|-------------------|------------|
+| Can be instantiated | No | Forbidden | [examples.schema.json](examples.schema.json) |
+
+## Examples Examples
+
+```json
+{"foo":"bi","bar":"bu"}
+```
+
+```json
+{"foo":"zip","bar":"zap"}
+```
+
+
+---
\ No newline at end of file

examples/generated-schemas/examples.schema.json

+{
+    "meta:license": [
+        "Copyright 2017 Adobe Systems Incorporated. All rights reserved.",
+        "This file is licensed to you under the Apache License, Version 2.0 (the 'License');",
+        "you may not use this file except in compliance with the License. You may obtain a copy",
+        "of the License at http://www.apache.org/licenses/LICENSE-2.0"
+    ],
+    "$schema": "http://json-schema.org/draft-06/schema#",
+    "$id": "https://example.com/schemas/examples",
+    "title": "Examples",
+    "type": "object",
+    "description": "This is an example schema with *multiple* examples. Too many examples? There can never be too many examples!",
+    "properties": {
+        "foo": {
+            "type": "string",
+            "description": "A simple string.",
+            "meta:example": "bar"
+        },
+        "bar": {
+            "type": "string",
+            "description": "A simple string.",
+            "meta:example": [
+                "bar",
+                "baz"
+            ]
+        }
+    },
+    "examples": [
+        {
+            "foo": "bi",
+            "bar": "bu"
+        },
+        {
+            "foo": "zip",
+            "bar": "zap"
+        }
+    ]
+}
\ No newline at end of file

examples/schemas/examples.example.1.json

+{
+  "foo": "bi",
+  "bar": "bu"
+}
\ No newline at end of file

examples/schemas/examples.example.2.json

+{
+  "foo": "zip",
+  "bar": "zap"
+}
\ No newline at end of file

lib/markdownWriter.js

@@ -62,6 +62,17 @@ function flatten(dependencies) {
   return deps;
 }
 
+function stringifyExamples(examples) {
+  if (examples) {
+    console.log(examples);
+    return examples.map(example => {
+      return JSON.stringify(example, 2);
+    });
+  } else {
+    return false;
+  }
+}
+
 const generateMarkdown = function(filename, schema, schemaPath, outDir, dependencyMap) {
   var ctx = {
     schema: schema,
@@ -83,6 +94,7 @@ const generateMarkdown = function(filename, schema, schemaPath, outDir, dependen
       props: schemaProps(schema, schemaPath, filename) } ],
     //[ 'divider.ejs', null ],
     //[ 'topSchema.ejs', ctx ],
+    [ 'examples.ejs', { examples: stringifyExamples(schema.examples), title: schema.title } ],
     [ 'divider.ejs', null ]
   ].map(([ template, context ]) => {
     return [

templates/md/examples.ejs

+<% /**
+ * Copyright 2017 Adobe Systems Incorporated. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ */ %><% if (examples && examples.length == 1) { %>
+## <%=title %> Example
+
+```json
+<%- examples[0] %>
+```
+<% } else if (examples && examples.length > 1) { %>
+## <%=title %> Examples
+<%  _.forEach(examples, example => { %>
+
+```json
+<%- example %>
+```
+
+<% }); %>
+<% } %>
\ No newline at end of file