AtHeartEngineer/Modernizr
1
1
Fork 0
mirror of https://github.com/Modernizr/Modernizr.git synced 2026-01-07 23:04:00 -05:00
Code Issues Packages Projects Releases Wiki Activity

Added introduction

Browse Source
This commit is contained in:
Markel F
2020-04-28 19:07:14 +02:00
parent 200dd4dc4a
commit 98005b1475
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
HOW_TO_WRITE_FEATURE_DETECTS.md
View File

@@ -1,3 +1,10 @@
# How to Write Feature Detects
The scope of this file is to help you to create new feature detects or edit existing ones. Here you will find details and guidelines that will help you understand how
Modernizr works.
#### Table of contents
[Metadata](#metadata)
## Metadata
At the top of every feature detect in Modernizr there is a JSON fragment that represents the metadata of the test. This data is used, for example, to build the webpage.
This is an example of this schema (it does not represent a real test):
@@ -45,4 +52,4 @@ Here it would go a description of the feature test. You can use **markdown** her
| `async` | optional | If the test supports async functionality | Defaults to false |
| `warnings` | optional | Notes to the developer using the script | Don't mistake it for knownBugs |
| `knownBugs` | optional | Bugs known of the test (e.g.: doesn't work in IE6) | |
| `notes` | optional | Links to resources | |
| `notes` | optional | Links to resources | |