Skip to content
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.

Sign up for GitHub

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

Add metadata documentation #2547

Merged
merged 13 commits into from
May 28, 2020
Merged

Add metadata documentation #2547

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
f05cc8b
Create metadata.md
Markel Apr 27, 2020
8b613bc
Update the table
Markel Apr 27, 2020
db85c73
Added builderAliases
Markel Apr 27, 2020
fac9b86
Updated aliases
Markel Apr 27, 2020
1bfbc59
Added relative links + should not mentions
Markel Apr 27, 2020
0b065dc
Notes edits
Markel Apr 27, 2020
a65cbad
Remove authors note
Markel Apr 28, 2020
200dd4d
Rename file
Markel Apr 28, 2020
98005b1
Added introduction
Markel Apr 28, 2020
73d0ac0
Revert "Added introduction"
Markel Apr 28, 2020
146e0b7
Sorry, signature problems
Markel Apr 28, 2020
00c78fd
Make some sentences a little bit more clear
Markel May 5, 2020
610fbbc
Solve necessity typo
Markel May 12, 2020
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
Prev Previous commit
Next Next commit
Revert "Added introduction" 
This reverts commit 98005b1.
  • Loading branch information
@Markel
Markel committed Apr 28, 2020
commit 73d0ac0a2ec79933b00643fa91e1e803e40a0e76
9 changes: 1 addition & 8 deletions HOW_TO_WRITE_FEATURE_DETECTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
# 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):
Expand Down Expand Up @@ -52,4 +45,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 | |