From adefdf8b3dcaf5b35e4e37f39587d5d8502c0378 Mon Sep 17 00:00:00 2001 From: "Chris E. Kelley" Date: Tue, 18 Jul 2017 12:31:02 +0200 Subject: [PATCH] Added custom field example, contrib info to README --- README.md | 4 ++++ guides/README.md | 8 ++++++++ guides/custom-field-component.ejs | 6 ++++++ guides/docs/4-custom-field-component.md | 1 + package-lock.json | 19 +++++++++++++++++++ 5 files changed, 38 insertions(+) create mode 100644 guides/custom-field-component.ejs create mode 100644 guides/docs/4-custom-field-component.md create mode 100644 package-lock.json diff --git a/README.md b/README.md index 03f6540..10ebaea 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,6 @@ # ng2.angular-formly.com Website for [Angular Formly 2](ng2.angular-formly.com) + +## Contributing to this website + +View guides/README.md to learn how to add documentation to this site. diff --git a/guides/README.md b/guides/README.md index 0020014..61df34b 100644 --- a/guides/README.md +++ b/guides/README.md @@ -1,3 +1,11 @@ +#### Development setup + +Install [harp](http://harpjs.com/): + +`npm install -g harp` + +Run `npm install` to have the app watch for changes. New documentation will automagically appear when you complete the following steps. + #### How to add more docs 1. Name your file using the following pattern: `#-name-of-doc.md` 2. Place `#-name-of-doc.md` in `guides/docs` diff --git a/guides/custom-field-component.ejs b/guides/custom-field-component.ejs new file mode 100644 index 0000000..5788d86 --- /dev/null +++ b/guides/custom-field-component.ejs @@ -0,0 +1,6 @@ +``` +<%- partial('_partials/guide', { + title: 'Custom Field Component Example', + selectedGuide: '../docs/4-custom-field-component' +}) %> +``` \ No newline at end of file diff --git a/guides/docs/4-custom-field-component.md b/guides/docs/4-custom-field-component.md new file mode 100644 index 0000000..b2d6695 --- /dev/null +++ b/guides/docs/4-custom-field-component.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..76132e3 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,19 @@ +{ + "name": "mobile.angular.io", + "version": "1.0.0", + "lockfileVersion": 1, + "requires": true, + "dependencies": { + "material-design-lite": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/material-design-lite/-/material-design-lite-1.3.0.tgz", + "integrity": "sha1-0ATOP+6Zoe63Sni4oyUTSl8RcdM=" + }, + "microsite-ui": { + "version": "git://github.com/angular/design-love.git#ae9d5333fcf7400b2ad7768588c2f05b57ae66d8", + "requires": { + "material-design-lite": "1.3.0" + } + } + } +}