Skip to content

Instantly share code, notes, and snippets.

@wbamberg
Last active February 20, 2019 18:27
Show Gist options
  • Save wbamberg/aa3ac706396394e0e1752599e5e21b53 to your computer and use it in GitHub Desktop.
Save wbamberg/aa3ac706396394e0e1752599e5e21b53 to your computer and use it in GitHub Desktop.
{
"html": {
"elements": {
"aside": {
"title": "<aside>: The Aside element",
"mdn_url": "https://developer.mozilla.org/docs/Web/HTML/Element/aside",
"interactive-example": "https://interactive-examples.mdn.mozilla.net/pages/tabbed/aside.html",//optional
"browser-compatibility": {//bcd_for_html.elements.aside},
"examples": [
{
"description": {
"title": "My first example", //optional
"width": 123, //optional
"height": 123, //optional
"description-text": "Some description text, may include <code> and <a> and <strong>" //optional
},
"sources": {
"html": "<aside>some HTML source goes here</aside>", //optional
"css": ".aside { color: green };", //optional,_not_sure_how_to_handle_formatting
"js": "const aside = document.querySelector('.aside');", //optional,_not_sure_how_to_handle_formatting
}
},
{
//another_example_could_go_here
}
],
"attributes": {
"global-attributes": [
{
"name": "attribute-name",
"type": "String", //could_also_be:_"URL",_"Number",_"Boolean"
"description-text": "Some description text, may include <code> and <a> and <strong>. HTML or Markdown?",
"values": [ //optional
{
"value": "string-value",
"description-text": "Some description text, may include <code> and <a> and <strong>. HTML or Markdown?"
},
{
//another_value_could_go_here
}
]
},
{
//another_attribute_could_go_here
}
],
"element-specific-attributes": [
//more_attributes,_just_like_the_global_ones
]
},
"prose": { //all_bits_of_prose.md
"short-description": "Some text, may include all sorts of tags. HTML or Markdown?",
"overview": "Some text, may include all sorts of tags. HTML or Markdown?",
"attributes-text": "Some text, may include all sorts of tags. HTML or Markdown?",
"usage-notes": "Some text, may include all sorts of tags. HTML or Markdown?",
"accessibility-concerns": "Some text, may include all sorts of tags. HTML or Markdown?",
"see-also": "Some text, may include all sorts of tags. HTML or Markdown?",
"additional-sections": [
{
"name": "name-of-comment-tag",
"description-text": "Some text, may include all sorts of tags. HTML or Markdown?"
},
{
//could_have_more_of_these
}
]
},
"contributors": [
{
"name": "username",
"profile-link": "link-to-profile-page"
}
]
}
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment