Skip to content

Added custom field example, contrib info to README #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
8 changes: 8 additions & 0 deletions guides/README.md
Original file line number Diff line number Diff line change
@@ -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`
Expand Down
6 changes: 6 additions & 0 deletions guides/custom-field-component.ejs
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
```
<%- partial('_partials/guide', {
title: 'Custom Field Component Example',
selectedGuide: '../docs/4-custom-field-component'
}) %>
```
1 change: 1 addition & 0 deletions guides/docs/4-custom-field-component.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<iframe width="100%" height="1000px" src="https://embed.plnkr.co/pdys7F/?show=preview&sidebar=none"></iframe>
19 changes: 19 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.