-
Notifications
You must be signed in to change notification settings - Fork 27
Conventions for Examples
You want to create and submit your own example? Great! While doing so, please stick to the following conventions:
Each example must reside in a directory of its own within the repository's root directory. Please choose a descriptive directory name! It must be lower case with words separated by underscores.
- Example:
coffee_machine
An example should have a description. The documentation must be in HTML, and it must be in a file named index.html on the top level of your example directory.
- Example:
coffee_machine/index.html
Please use the following HTML code as a template for your index.html file and modify it as needed:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>The Example's Title Goes Here</title>
<link href="../css/style.css" rel="stylesheet">
</head>
<body class="body-container">
<h1>The Example's Title Goes Here</h1>
<p>The example's description goes here. Use HTML elements as you see fit.
You can use images like this one:</p>
<p><img class="standard-image" alt="The state machine" src="images/the_state_machine.png"/></p>
</body>
Images must be contained in a directory named images.
- Example:
coffee_machine/images/the_state_machine.png
Names of directories and files must be lower case with words separated by underscores.
An example must have a title which should describe the example as concise as possible. The title must occur identically at the following places:
- as the
<title>element in the index.html file, - as the first (and only)
<h1>element in the index.html file, - as the
titleattribute in the metadata.json file.