Skip to content

Latest commit

 

History

History
157 lines (102 loc) · 2.79 KB

README.md

File metadata and controls

157 lines (102 loc) · 2.79 KB
Raw

MIT Punya Tutorials

This repository contains tutorials for the MIT Punya system. Tutorials are primarily written in Markdown and should be placed, with supporting assets, under the tutorials directory.

Tutorials can be specified in a project template by putting the URL in the TutorialURL property of Screen1. For example, the RDF Notepad tutorial URL will be:

https://mit-dig.github.io/punya-tutorials/tutorials/rdf-notepad.html

The remainder of this readme explains how to author tutorials with Markdown.

Creating Headers

The top level accordion is composed of level 1 headings. You can indicate these in two different ways:

# Header

or

Header
======

Creating Tutorial Pages

Tutorial pages are added by creating a level 2 heading underneath a level 1 heading:

# Heading

## Page 1 Title

Page 1 Content

## Page 2 Title

Page 2 Content

If you prefer the underlining method of headers, you can use -:

Heading
=======

Page 1 Title
------------

Page 1 Content

Page 2 Title
------------

Page 2 Content

Adding a How-To

For tutorials that include information about connecting the companion, you can add the how-to using this technique:

# Connect to App

<howto id="connect_app"></howto>

Adding Hints

You can add hints to the tutorial using the following technique:

<hint markdown="block" title="Give me a hint">

Hint content

</hint>

You can also nest hints:

<hint markdown="block" title="Give me a hint">

Hint content

<hint markdown="block" title="Check my solution">

Solution content

</hint>

</hint>

Ordered Lists

Ordered lists are created by using numbers:

1. Item 1
2. Item 2
3. Item 3

If you need more advanced functionality, such as a starting value, you can also make use of HTML:

<ol start="4">
<li>Item 4</li>
<li>Item 5</li>
</ol>

Unordered Lists

Unordered lists are used by using certain characters like bullets:

* First
* Second
* Third

You can nest lists as well:

* First
   * Subitem
   * Subitem
   * Subitem
* Second

Links & Images

Links are created by placing the text for the link within square brackets [] and the link target in parentheses ():

[Go to App Inventor](http://ai2.appinventor.mit.edu)

To create an image, use the link syntax and place an exclamation in front:

![Alternative text for accessibility)(http://link/to/image.png)

If you want to make it so that the image can be enlarged, include {:.enlargeImage} at the end of the image inclusion text:

![A big image](image.png){:.enlargeImage}

If you need to center a smaller image, you can do so by adding {:.center} on its own line immediately after the image markdown.